@mitre/inspec-objects 0.0.2 → 0.0.5

package/src/utilities/diff.ts

@@ -1,60 +0,0 @@
-import { diff } from 'json-diff';
-import Profile from '../objects/profile';
-import { ProfileDiff } from '../types/diff';
-import _ from 'lodash'
-import Control from '../objects/control';
-
-export function updateControl(originalControlString: string, originalControl: Control, updatedControl: Control) {
-    console.log('Here is the original control:');
-}
-
-export function diffProfile(fromProfile: Profile, toProfile: Profile): ProfileDiff {
-    const profileDiff: ProfileDiff = {
-        addedControlIDs: [],
-        removedControlIDs: [],
-        changedControls: {}
-    };
-
-    const fromControlIDs = fromProfile.controls.map((control) => control.id).sort();
-    const toControlIDs = toProfile.controls.map((control) => control.id).sort();
-
-    // Find new controls
-    const controlIDDiff: string[][] | undefined = diff(fromControlIDs, toControlIDs)
-
-    controlIDDiff?.forEach((diffValue) => {
-        if (diffValue[0] === '-') {
-            profileDiff.removedControlIDs.push(diffValue[1])
-        } else if (diffValue[0] === '+') {
-            profileDiff.addedControlIDs.push(diffValue[1])
-        }
-    })
-
-    // Add new controls to changedControls
-    profileDiff.addedControlIDs.forEach((addedControl) => {
-        const newControl = toProfile.controls.find((control) => addedControl === control.id)
-        if (newControl) {
-            profileDiff.changedControls[addedControl] = newControl
-        }
-    })
-
-    // Find changed controls
-    for (const fromControl of fromProfile.controls) {
-        const toControl = toProfile.controls.find((control) => control.id === fromControl.id)
-        if (toControl) {
-            const controlDiff: Record<string, any> | undefined = diff(fromControl, toControl);
-            if (controlDiff) {
-                Object.entries(controlDiff).forEach(([key, value]) => {
-                    if (_.has(value, '__new')) {
-                        _.set(profileDiff, 'changedControls.'+fromControl.id +'.'+key.replace('.', '\\.'), _.get(controlDiff, key+'.__new'))
-                    } else if (typeof value === 'object') {
-                        Object.entries(value).forEach(([subKey]) => {
-                            _.set(profileDiff, 'changedControls.'+fromControl.id +'.'+key.replace('.', '\\.')+'.'+subKey.replace('.', '\\.'), _.get(controlDiff, key+'.'+subKey+'.__new'))
-                        })
-                    }
-                })
-            }
-        }
-    }
-
-    return profileDiff
-}

package/src/utilities/global.ts

@@ -1,52 +0,0 @@
-import _ from "lodash";
-
-// Breaks lines down to lineLength number of characters
-export function wrap(s: string, lineLength = 80): string {
-  return s.replace(
-    new RegExp(`(?![^\n]{1,${lineLength}}$)([^\n]{1,${lineLength}})`, "g"),
-    "$1\n"
-  );
-}
-
-export function unformatText(s: string): string {
-  return s.replace(/\n/g, ' ').replace(/\\n/g, ' ').replace(/( +|\t)/g, ' ')
-}
-
-const escapeQuotes = (s: string) =>
-  s.replace(/\\/g, "\\\\").replace(/'/g, "\\'"); // Escape backslashes and quotes
-const escapeDoubleQuotes = (s: string) =>
-  s.replace(/\\/g, "\\\\").replace(/"/g, '\\"'); // Escape backslashes and double quotes
-
-const wrapAndEscapeQuotes = (s: string, lineLength?: number) =>
-  escapeDoubleQuotes(wrap(s, lineLength)); // Escape backslashes and quotes, and wrap long lines
-
-export { escapeQuotes, escapeDoubleQuotes, wrapAndEscapeQuotes };
-
-export function getFirstPath(
-  object: Record<string, unknown>,
-  paths: string[]
-): string {
-  const index = _.findIndex(paths, (p) => hasPath(object, p));
-
-  if (index === -1) {
-    throw new Error(
-      `Attestation is missing one of these paths: ${paths.join(', ')}`
-    );
-  } else {
-    return _.get(object, paths[index]) as string;
-  }
-}
-
-export function hasPath(
-  file: Record<string, unknown>,
-  path: string | string[]
-): boolean {
-  let pathArray;
-  if (typeof path === 'string') {
-    pathArray = [path];
-  } else {
-    pathArray = path;
-  }
-
-  return _.some(pathArray, (p) => _.has(file, p));
-}

package/src/utilities/xccdf.ts

@@ -1,115 +0,0 @@
-import parser from 'fast-xml-parser'
-import * as htmlparser from 'htmlparser2'
-import _ from 'lodash'
-import { DecodedDescription } from '../types/xccdf'
-import fs from 'fs'
-import { randomUUID } from 'crypto'
-
-export function convertEncodedXmlIntoJson(
-    encodedXml: string
-  ): any {
-    return parser.parse(encodedXml, {
-      ignoreAttributes: false,
-      ignoreNameSpace: true,
-      attributeNamePrefix: '@_',
-      arrayMode: true
-    })
-}
-
-export function severityStringToImpact(string: string, id: string): number {
-  if (string.match(/none|na|n\/a|not[\s()*_|]?applicable/i)?.length) {
-    return 0.0
-  }
-
-  if (string.match(/low|cat(egory)?\s*(iii|3)/i)?.length) {
-    return 0.3
-  }
-
-  if (string.match(/med(ium)?|cat(egory)?\s*(ii|2)/)?.length) {
-    return 0.5
-  }
-
-  if (string.match(/high|cat(egory)?\s*(i|1)/)?.length) {
-    return 0.7
-  }
-
-  if (string.match(/crit(ical)?|severe/)?.length) {
-    return 1.0
-  }
-
-  console.log(`${string} is not a valid severity value. It should be one of the approved keywords. ${id} will be treated as medium severity`)
-  return 0.5;
-}
-
-export function impactNumberToSeverityString(impact: number): string {
-  // Impact must be 0.0 - 1.0
-  if (impact < 0.0 || impact > 1.0) {
-    throw new Error('Impact cannot be less than 0.0 or greater than 1.0')
-  } else {
-    if (impact >= 0.9) {
-      return 'critical'
-    }
-
-    if (impact >= 0.7) {
-      return 'high'
-    }
-
-    if (impact >= 0.4) {
-      return 'medium'
-    }
-
-    if (impact >= 0.1) {
-      return 'low'
-    }
-
-    return 'none'
-  }
-}
-
-export function convertEncodedHTMLIntoJson(encodedHTML?: string): DecodedDescription {
-  if (encodedHTML) {
-    // Some STIGs regarding XSS put the < character inside of the description which breaks parsing
-    const patchedHTML = encodedHTML.replace(/"&lt;"/g, '[[[REPLACE_LESS_THAN]]]')
-
-    const xmlChunks: string[] = []
-    const htmlParser = new htmlparser.Parser({
-      ontext(text: string) {
-        xmlChunks.push(text)
-      },
-    })
-    htmlParser.write(patchedHTML)
-    htmlParser.end()
-    const converted = convertEncodedXmlIntoJson(xmlChunks.join(''))
-    let cleaned: Record<string, string | boolean | undefined> = {}
-
-    if (typeof converted.VulnDiscussion === 'object') { // Some STIGs have xml tags inside of the actual text which breaks processing, e.g U_ASD_STIG_V5R1_Manual-xccdf.xml and all Oracle Database STIGs
-      let extractedVulnDescription = ''
-      const remainingFields = _.omit(converted.VulnDiscussion, ['FalsePositives', 'FalseNegatives', 'Documentable', 'Mitigations', 'SeverityOverrideGuidance', 'PotentialImpacts', 'ThirdPartyTools', 'MitigationControl', 'Responsibility', 'IAControls'])
-      Object.entries(remainingFields).forEach(([field, value]) => {
-        extractedVulnDescription += `<${field}> ${value}`
-      })
-      cleaned = {
-        VulnDiscussion: extractedVulnDescription.replace(/\[\[\[REPLACE_LESS_THAN]]]/, '"<"'),
-      }
-      Object.entries(converted.VulnDiscussion).forEach(([key, value]) => {
-        if (typeof value === 'string') {
-          cleaned[key] = value.replace(/\[\[\[REPLACE_LESS_THAN]]]/, '"<"')
-        } else {
-          cleaned[key] = (value as boolean)
-        }
-      })
-    } else {
-      Object.entries(converted).forEach(([key, value]) => {
-        if (typeof value === 'string') {
-          cleaned[key] = value.replace(/\[\[\[REPLACE_LESS_THAN]]]/, '"<"')
-        } else {
-          cleaned[key] = (value as boolean)
-        }
-      })
-    }
-
-    return cleaned
-  }
-
-  return {}
-}

package/types/ionchannelAnalysis.d.ts

@@ -1,238 +0,0 @@
-export type ContextualizedDependency = Dependency & {
-  parentDependencies: string[];
-};
-
-export type IonChannelAnalysisResponse = {
-  analysis: IonChannelAnalysis;
-};
-
-export type IonChannelAnalysis = {
-  id: string;
-  analysis_id: string;
-  team_id: string;
-  project_id: string;
-  name: string;
-  text: string;
-  type: string;
-  source: string;
-  branch: string;
-  description: string;
-  risk: string;
-  summary: string;
-  passed: boolean;
-  ruleset_id: string;
-  ruleset_name: string;
-  status: string;
-  created_at: Date;
-  updated_at: Date;
-  duration: number;
-  trigger_hash: string;
-  trigger_text: string;
-  trigger_author: string;
-  trigger: string;
-  scan_summaries: ScanSummary[];
-  public: boolean;
-};
-
-export type ScanSummary = {
-  id: string;
-  team_id: string;
-  project_id: string;
-  analysis_id: string;
-  summary: string;
-  results: Results;
-  created_at: Date;
-  updated_at: Date;
-  duration: number;
-  name: string;
-  description: string;
-};
-
-export type Results = {
-  type: string;
-  data: Data;
-};
-
-export type Data = {
-  vulnerabilities?: DataVulnerability[];
-  meta?: Meta;
-  dependencies?: Dependency[];
-  CSS?: number;
-  HTML?: number;
-  JavaScript?: number;
-  Vue?: number;
-  committers?: number;
-  name?: string;
-  url?: string;
-  committed_at?: Date;
-  old_names?: string[];
-  stars?: number;
-  name_changed?: boolean;
-  compilers?: null;
-  docker_file?: DockerFile;
-  known_viruses?: number;
-  engine_version?: string;
-  scanned_directories?: number;
-  scanned_files?: number;
-  infected_files?: number;
-  data_scanned?: string;
-  data_read?: string;
-  time?: string;
-  file_notes?: Record<string, unknown>;
-  clam_av_details?: ClamAVDetails;
-  license?: License;
-  checksum?: string;
-  difference?: boolean;
-  message?: string;
-  valid?: boolean;
-  content?: string;
-};
-
-export type ClamAVDetails = {
-  clamav_version: string;
-  clamav_db_version: string;
-};
-
-export type Dependency = {
-  latest_version: string;
-  org: string;
-  name: string;
-  type: string;
-  package: string;
-  version: string;
-  scope: Scope;
-  requirement: string;
-  file: File;
-  outdated_version: OutdatedVersion;
-  dependencies: Dependency[];
-};
-
-export enum File {
-  Empty = '',
-  PackageJSON = 'package.json'
-}
-
-export type OutdatedVersion = {
-  major_behind: number;
-  minor_behind: number;
-  patch_behind: number;
-};
-
-export enum Scope {
-  Runtime = 'runtime'
-}
-
-export type DockerFile = {
-  images: null;
-  dependencies: null;
-};
-
-export type License = {
-  name: string;
-  type: TypeElement[];
-};
-
-export type TypeElement = {
-  name: string;
-  confidence: number;
-};
-
-export type Meta = {
-  vulnerability_count?: number;
-  resolved_to?: string;
-  first_degree_count?: number;
-  no_version_count?: number;
-  total_unique_count?: number;
-  update_available_count?: number;
-  vulnerable_count?: number;
-};
-
-export type DataVulnerability = {
-  id: number;
-  external_id: string;
-  source_id: number;
-  title: string;
-  name: string;
-  org: string;
-  version: string;
-  up: string;
-  edition: string;
-  aliases: null;
-  created_at: Date;
-  updated_at: Date;
-  references: null;
-  part: string;
-  language: string;
-  vulnerabilities: VulnerabilityVulnerability[];
-  query: Dependency;
-};
-
-export type VulnerabilityVulnerability = {
-  id: number;
-  external_id: string;
-  source: Source[];
-  title: string;
-  summary: string;
-  score: string;
-  score_version?: string;
-  score_system: string;
-  score_details: ScoreDetails;
-  vector: string;
-  access_complexity: string;
-  vulnerability_authentication: string;
-  confidentiality_impact: string;
-  integrity_impact: string;
-  availability_impact: string;
-  vulnerabilty_source: string;
-  assessment_check: null;
-  scanner: null;
-  recommendation: string;
-  references: null;
-  modified_at: Date;
-  published_at: Date;
-  created_at: Date;
-  updated_at: Date;
-  mttr_seconds: null;
-  dependencies: null;
-};
-
-export type ScoreDetails = {
-  cvssv2?: Cvssv2;
-  cvssv3?: Cvssv3;
-};
-
-export type Cvssv2 = {
-  vectorString: string;
-  accessVector: string;
-  accessComplexity: string;
-  authentication: string;
-  confidentialityImpact: string;
-  integrityImpact: string;
-  availabilityImpact: string;
-  baseScore: number;
-};
-
-export type Cvssv3 = {
-  vectorString: string;
-  attackVector: string;
-  attackComplexity: string;
-  privilegesRequired: string;
-  userInteraction: string;
-  scope: string;
-  confidentialityImpact: string;
-  integrityImpact: string;
-  availabilityImpact: string;
-  baseScore: number;
-  baseSeverity: string;
-};
-
-export type Source = {
-  id: number;
-  name: string;
-  description: string;
-  created_at: Date;
-  updated_at: Date;
-  attribution: string;
-  license: string;
-  copyright_url: string;
-};

package/types/ionchannelProjects.d.ts

@@ -1,72 +0,0 @@
-export type Projects = {
-  data: Project[];
-  meta: Meta;
-};
-
-export type Project = {
-  id: string;
-  team_id: string;
-  name: string;
-  active: boolean;
-  draft: boolean;
-  chat_channel: string;
-  created_at: Date;
-  updated_at: Date;
-  deploy_key: string;
-  should_monitor: boolean;
-  monitor_frequency: string;
-  poc_name: string;
-  poc_email: string;
-  username: string;
-  password: string;
-  key_fingerprint: string;
-  private: boolean;
-  aliases: null;
-  tags: null;
-  ruleset_history: null;
-  sbom_id: string;
-  sbom_entry_id: string;
-  cpe: string;
-  purl: string;
-  ruleset_name: string;
-  analysis_summary: AnalysisSummary;
-  status: Status;
-};
-
-export type AnalysisSummary = {
-  id: string;
-  analysis_id: string;
-  team_id: string;
-  project_id: string;
-  name: string;
-  text: null;
-  type: string;
-  source: string;
-  branch: string;
-  description: string;
-  risk: string;
-  summary: string;
-  passed: boolean;
-  ruleset_id: string;
-  ruleset_name: string;
-  status: string;
-  created_at: Date;
-  updated_at: Date;
-  duration: number;
-  trigger_hash: string;
-  trigger_text: string;
-  trigger_author: string;
-  trigger: string;
-};
-
-export enum Status {
-  Errored = 'errored',
-  Failing = 'failing',
-  Passing = 'passing'
-}
-
-export type Meta = {
-  total_count: number;
-  limit: number;
-  offset: number;
-};

package/types/ionchannelTeams.d.ts

@@ -1,26 +0,0 @@
-export type IonChannelTeams = {
-  data: Team[];
-  meta: Meta;
-};
-
-export type Team = {
-  id: string;
-  created_at: Date;
-  updated_at: Date;
-  deleted_at: Date;
-  name: string;
-  delivering: boolean;
-  sys_admin: boolean;
-  poc_name: string;
-  poc_email: string;
-  default_deploy_key: string;
-  organization_id: string;
-  user_id: string;
-  role: string;
-  status: string;
-};
-
-export type Meta = {
-  total_count: number;
-  offset: number;
-};

package/types/reverseMappedXCCDF.d.ts

@@ -1,67 +0,0 @@
-export type MappedXCCDFtoHDF = {
-  Benchmark: Benchmark;
-};
-
-export type Benchmark = {
-  id: string;
-  date: string;
-  title: string;
-  Profile: Profile[];
-  Rule: Rule[];
-  metadata: MetaData;
-  passthrough: string;
-  version: string;
-  TestResult: {
-    endTime: string;
-    hasAttributes: boolean;
-    // Any as defined by InSpec Inputs, matching InSpecJS
-    attributes: {[key: string]: any}[];
-    results: TestResult[];
-  };
-};
-
-export type Profile = {
-  id: string;
-  title: string;
-  description: string;
-  select: string[];
-};
-
-export type Rule = {
-  groupId?: string;
-  id: string;
-  title?: string;
-  description?: string;
-  code?: string;
-  warning?: string;
-  rationale?: string;
-  checkContent?: string;
-  fix?: string;
-  ccis: string[];
-};
-
-export type MetaData = {
-  maintainer?: string;
-  copyright?: string;
-};
-
-export type XCCDFSeverity = 'info' | 'low' | 'medium' | 'high';
-
-export type TestResultStatus =
-  | 'pass'
-  | 'fail'
-  | 'error'
-  | 'unknown'
-  | 'notapplicable'
-  | 'notchecked'
-  | 'notselected'
-  | 'informational'
-  | 'fixed';
-
-export type TestResult = {
-  idref: string;
-  result: TestResultStatus;
-  messageType: string;
-  message: string;
-  code: string;
-};