@mitre/inspec-objects 0.0.3 → 0.0.4

package/src/objects/control.ts

@@ -1,148 +0,0 @@
-import { ExecJSON } from "inspecjs";
-import _ from "lodash";
-import {flatten, unflatten} from "flat"
-import { escapeQuotes, unformatText, wrapAndEscapeQuotes } from "../utilities/global";
-
-export default class Control {
-  id?: string | null;
-  title?: string | null;
-  code?: string | null;
-  desc?: string | null;
-  descs?: ExecJSON.ControlDescription[] | { [key: string]: string | undefined } | null;
-  impact?: number;
-  ref?: string;
-  refs?: (string | {
-    ref?: string;
-    url?: string;
-    uri?: string;
-  })[];
-  tags: {
-    check?: string;
-    fix?: string;
-    severity?: string;
-    gtitle?: string;
-    gid?: string;
-    satisfies?: string[];
-    rid?: string;
-    stig_id?: string;
-    fix_id?: string | null;
-    cci?: string[];
-    cis_controls?: Record<string, string[]>[];
-    nist?: string[];
-    legacy?: string[];
-    false_negatives?: string;
-    false_positives?: string;
-    documentable?: boolean;
-    mitigations?: string;
-    severity_override_guidance?: string;
-    potential_impacts?: string;
-    third_party_tools?: string;
-    mitigation_controls?: string;
-    responsibility?: string;
-    ia_controls?: string;
-    [key: string]:
-      | string
-      | string[]
-      | Record<string, string[]>[]
-      | boolean
-      | undefined
-      | null;
-  } = {};
-
-  constructor(data?: Partial<Control>) {
-    this.refs = []
-    this.tags = {}
-    if (data) {
-      Object.entries(data).forEach(([key, value]) => {
-        _.set(this, key, value);
-      });
-    }
-  }
-
-  toUnformattedObject(): Control {
-    const flattened: Record<string, string | number> = flatten(this)
-    
-    Object.entries(flattened).forEach(([key, value]) => {
-      if(typeof value === 'string') {
-        _.set(flattened, key, unformatText(value));
-      }
-    });
-
-    return new Control(unflatten(flattened));
-  }
-
-  toRuby(lineLength: number = 80) {
-    let result = "# encoding: UTF-8\n\n";
-
-    result += `control "${this.id}" do\n`;
-    if (this.title) {
-      result += `  title "${wrapAndEscapeQuotes(this.title, lineLength)}"\n`;
-    } else {
-      console.error(`${this.id} does not have a title`);
-    }
-
-    if (this.desc) {
-      result += `  desc "${wrapAndEscapeQuotes(this.desc, lineLength)}"\n`;
-    } else {
-      console.error(`${this.id} does not have a desc`);
-    }
-
-    if (this.descs) {
-      Object.entries(this.descs).forEach(([key, desc]) => {
-        if (desc) {
-          result += `  desc "${key}", "${wrapAndEscapeQuotes(
-            desc,
-            lineLength
-          )}"\n`;
-        } else {
-          console.error(`${this.id} does not have a desc for the value ${key}`);
-        }
-      });
-    }
-
-    if (this.impact) {
-      result += `  impact ${this.impact}\n`;
-    } else {
-      console.error(`${this.id} does not have an impact`);
-    }
-
-    if (this.refs) {
-      this.refs.forEach((ref) => {
-        if (typeof ref === 'string') {
-          result += `  ref '${escapeQuotes(ref)}'\n`;
-        } else {
-          result += `  ref '${escapeQuotes(ref.ref || '')}', url: '${escapeQuotes(ref.url || '')}'`
-        }
-        
-      });
-    }
-
-    Object.entries(this.tags).forEach(([tag, value]) => {
-      if (value) {
-        if (typeof value === "object") {
-          if (Array.isArray(value) && typeof value[0] === "string") {
-            result += `  tag ${tag}: ${JSON.stringify(value)}\n`;
-          } else {
-            // Convert JSON Object to Ruby Hash
-            const stringifiedObject = JSON.stringify(value, null, 2)
-              .replace(/\n/g, "\n  ")
-              .replace(/\{\n {6}/g, "{")
-              .replace(/\[\n {8}/g, "[")
-              .replace(/\n {6}\]/g, "]")
-              .replace(/\n {4}\}/g, "}")
-              .replace(/": \[/g, '" => [');
-            result += `  tag ${tag}: ${stringifiedObject}\n`;
-          }
-        } else if (typeof value === "string") {
-          result += `  tag ${tag}: "${wrapAndEscapeQuotes(
-            value,
-            lineLength
-          )}"\n`;
-        }
-      }
-    });
-    result += "end";
-
-    return result;
-  }
-}

package/src/objects/profile.ts

@@ -1,93 +0,0 @@
-import Control from "./control";
-import YAML from "yaml";
-import _ from "lodash";
-import { unformatText } from "../utilities/global";
-
-export default class Profile {
-  name?: string | null;
-  title?: string | null;
-  maintainer?: string | null;
-  copyright?: string | null;
-  copyright_email?: string | null;
-  license?: string | null;
-  summary?: string | null;
-  description?: string | null;
-  version?: string | null;
-  inspec_version?: string | null;
-  supports: {
-    "platform-family"?: string;
-    "platform-name"?: string;
-    "os-name"?: string;
-    "os-family"?: string;
-    release?: string;
-    platform?: string;
-  }[] = [];
-  depends: {
-    // Required for all
-    name: string; // Required for all
-
-    // Local file
-    path?: string; // Local path on disk
-
-    // Remote HTTP(s)
-    url?: string; // Remote URL tarball
-    username?: string; // HTTP Basic Authentication Username
-    password?: string; // HTTP Basic Authentication Password
-
-    // Git Repository
-    git?: string;
-    branch?: string;
-    tag?: string;
-    commit?: string;
-    version?: string;
-    relative_path?: string;
-
-    // Chef Supermarket
-    supermarket?: string;
-
-    // Base Compliance
-    compliance?: string;
-  }[] = [];
-  inputs: { [key: string]: string }[] = [];
-  gem_dependencies?: {name: string, version: string}[];
-  libraries: string[] = [];
-  readme?: string | null;
-  files: string[] = [];
-  controls: Control[] = [];
-
-  constructor(data?: Omit<Partial<Profile>, "controls">) {
-    if (data) {
-      Object.entries(data).forEach(([key, value]) => {
-        _.set(this, key, value);
-      });
-    }
-  }
-
-  createInspecYaml(): string {
-    return YAML.stringify({
-      name: this.name,
-      title: this.title,
-      maintainer: this.maintainer,
-      copyright: this.copyright,
-      copyright_email: this.copyright_email,
-      license: this.license,
-      summary: this.summary,
-      description: this.description,
-      version: this.version,
-      supports: this.supports,
-      depends: this.depends,
-      inspec_version: this.inspec_version,
-    });
-  }
-
-  toUnformattedObject(): Profile {
-    const unformattedProfile: Profile = new Profile(this);
-    Object.entries(this).forEach(([key, value]) => {
-      if (typeof value === "string") {
-        _.set(unformattedProfile, key, unformatText(value));
-      }
-    });
-    unformattedProfile.controls = this.controls.map((control) => control.toUnformattedObject())
-    return unformattedProfile;
-  }
-}

package/src/parsers/json.ts

@@ -1,92 +0,0 @@
-import {
-  ContextualizedEvaluation,
-  ContextualizedProfile,
-  contextualizeEvaluation,
-  contextualizeProfile,
-  ConversionResult,
-  convertFile,
-  ExecJSON
-} from "inspecjs";
-import _ from "lodash";
-import Control from "../objects/control";
-import Profile from "../objects/profile";
-
-export function processEvaluation(evaluationInput: ContextualizedEvaluation) {
-  const topLevelProfile = evaluationInput.contains[0];
-  const profile = new Profile({
-    name: topLevelProfile.data.name,
-    title: topLevelProfile.data.title,
-    maintainer: topLevelProfile.data.maintainer,
-    copyright: topLevelProfile.data.copyright,
-    copyright_email: topLevelProfile.data.copyright_email,
-    license: _.get(topLevelProfile.data, "license"),
-    summary: _.get(topLevelProfile.data, "summary"),
-    description: _.get(topLevelProfile.data, "description"),
-    version: topLevelProfile.data.version,
-  });
-  topLevelProfile.contains.forEach((control) => {
-    profile.controls.push(
-      new Control({
-        id: control.data.id,
-        title: control.data.title,
-        impact: control.data.impact,
-        desc: control.data.desc,
-        descs: control.hdf.wraps.descriptions,
-        tags: control.hdf.wraps.tags,
-      })
-    );
-  });
-  return profile;
-}
-
-export function processProfileJSON(
-  profileInput: ContextualizedProfile
-): Profile {
-  const profile = new Profile({
-    name: profileInput.data.name,
-    title: profileInput.data.title,
-    maintainer: profileInput.data.maintainer,
-    copyright: profileInput.data.copyright,
-    copyright_email: profileInput.data.copyright_email,
-    license: _.get(profileInput.data, "license"),
-    summary: _.get(profileInput.data, "summary"),
-    description: _.get(profileInput.data, "description"),
-    version: profileInput.data.version,
-  });
-  profileInput.data.controls.forEach((control) => {
-    profile.controls.push(
-      new Control({
-        id: control.id,
-        title: control.title,
-        desc: control.desc,
-        impact: control.impact,
-        code: control.code,
-        tags: control.tags,
-        descs: control.descriptions,
-      })
-    );
-  });
-  return profile;
-}
-
-export function processExecJSON(execJSON: ExecJSON.Execution) {
-  return processEvaluation(contextualizeEvaluation(execJSON));
-}
-
-export function processJSON(json: string): Profile {
-  const convertedFile: ConversionResult = convertFile(json, true);
-  let profile = new Profile();
-  if (convertedFile["1_0_ExecJson"]) {
-    profile = processEvaluation(
-      contextualizeEvaluation(convertedFile["1_0_ExecJson"])
-    ).toUnformattedObject();
-  } else if (convertedFile["1_0_ProfileJson"]) {
-    profile = processProfileJSON(contextualizeProfile(JSON.parse(json))).toUnformattedObject();
-  } else {
-    throw new Error("Unknown file type passed");
-  }
-
-  profile.controls = _.sortBy(profile.controls, "id");
-
-  return profile;
-}

package/src/parsers/oval.ts

@@ -1,18 +0,0 @@
-import { convertEncodedXmlIntoJson } from "../utilities/xccdf"
-import {OvalDefinitionValue, Oval} from '../types/oval'
-
-export function processOVAL(oval: string): Record<string, OvalDefinitionValue> {
-    const parsed: Oval = convertEncodedXmlIntoJson(oval)
-
-    const extractedDefinitions: Record<string, OvalDefinitionValue> = {}
-
-    for (const ovalDefinitions of parsed.oval_definitions) {
-        for (const definitionList of ovalDefinitions.definitions) {
-            for (const definition of definitionList.definition) { 
-                extractedDefinitions[definition["@_id"]] = definition
-            }
-        }
-    }
-
-    return extractedDefinitions
-}

package/src/parsers/xccdf.ts

@@ -1,252 +0,0 @@
-import Profile from '../objects/profile';
-import { convertEncodedHTMLIntoJson, convertEncodedXmlIntoJson, impactNumberToSeverityString, removeXMLSpecialCharacters, severityStringToImpact } from '../utilities/xccdf';
-import { BenchmarkGroup, BenchmarkRule, DecodedDescription, FrontMatter, Notice, ParsedXCCDF, RationaleElement } from '../types/xccdf';
-import Control from '../objects/control';
-import _ from 'lodash';
-import { OvalDefinitionValue } from '../types/oval';
-import {data as CciNistMappingData} from '../mappings/CciNistMappingData'
-
-export type GroupContextualizedRule = BenchmarkRule & {group: Omit<BenchmarkGroup, 'Rule' | 'Group'>}
-
-export function extractAllRules(groups: BenchmarkGroup[]): GroupContextualizedRule[] {
-    const rules: GroupContextualizedRule[] = [];
-    groups.forEach((group) => {
-        if (group.Rule) {
-            rules.push(...(group.Rule.map((rule) => {
-                return {
-                    ...rule,
-                    group: _.omit(group, ['Rule', 'Group'])
-                }
-            })))
-        }
-        if (group.Group) {
-            rules.push(...extractAllRules(group.Group))
-        }
-    })
-    return rules
-}
-
-export function processXCCDF(xml: string, removeNewlines = false, ovalDefinitions?: Record<string, OvalDefinitionValue>): Profile {
-    const parsedXML: ParsedXCCDF = convertEncodedXmlIntoJson(xml)
-    const rules = extractAllRules(parsedXML.Benchmark[0].Group)
-
-    const profile = new Profile({
-        name: parsedXML.Benchmark[0]['@_id'],
-        title: (parsedXML.Benchmark[0].title[0] as FrontMatter)['#text'],
-        summary: (parsedXML.Benchmark[0].description[0] as RationaleElement)['#text']
-    });
-
-    rules.forEach(rule => {
-        let extractedDescription: string | DecodedDescription;
-        if (Array.isArray(rule.description)) {
-            extractedDescription = rule.description[0]['#text']
-        } else {
-            extractedDescription = convertEncodedHTMLIntoJson(rule.description)
-        }
-        const control = new Control();
-
-        control.id = rule.group['@_id']
-        
-        if (removeNewlines) {
-            const title = removeXMLSpecialCharacters(rule['@_severity'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${rule.title}`)
-            control.title = title.replace(/\n/g, '{{{{newlineHERE}}}}')
-            const desc = removeXMLSpecialCharacters(typeof extractedDescription === 'string' ? extractedDescription :  extractedDescription.VulnDiscussion?.split('Satisfies: ')[0] || 'Missing Description')
-            control.desc = desc?.replace(/\n/g, '{{{{newlineHERE}}}}')
-        } else {
-            control.title = removeXMLSpecialCharacters(rule['@_severity'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${rule.title}`)
-            control.desc = removeXMLSpecialCharacters(typeof extractedDescription === 'string' ? extractedDescription :  extractedDescription.VulnDiscussion?.split('Satisfies: ')[0] || 'Missing Description')
-        }
-        control.impact = severityStringToImpact(rule['@_severity'] || 'critical', rule.group['@_id'])
-        
-        if (!control.descs || Array.isArray(control.descs)) {
-            control.descs = {}
-        }
-
-        if (rule.check) {
-            if (rule.check.some((ruleValue) => 'check-content' in ruleValue)) {
-                if (removeNewlines) {
-                    const check = removeXMLSpecialCharacters(rule.check ? rule.check[0]['check-content'] : 'Missing description')
-                    control.descs.check = check.replace(/\n/g, '{{{{newlineHERE}}}}')
-                } else {
-                    control.descs.check = removeXMLSpecialCharacters(rule.check ? rule.check[0]['check-content'] : 'Missing description')
-                }
-                
-            } else if (rule.check.some((ruleValue) => 'check-content-ref' in ruleValue) && ovalDefinitions) {
-                let referenceID: string | null = null;
-                for (const checkContent of rule.check) {
-                    if ('check-content-ref' in checkContent && checkContent['@_system'].includes('oval')) {
-                        for (const checkContentRef of checkContent['check-content-ref']) {
-                            if (checkContentRef['@_name']) {
-                                referenceID = checkContentRef['@_name']
-                            }
-                        }
-                    }
-                }
-                if (referenceID && referenceID in ovalDefinitions) {
-                    if (removeNewlines) {
-                        const check = removeXMLSpecialCharacters(ovalDefinitions[referenceID].metadata[0].title)
-                        control.descs.check = check.replace(/\n/g, '{{{{newlineHERE}}}}')
-                    } else {
-                        control.descs.check = removeXMLSpecialCharacters(ovalDefinitions[referenceID].metadata[0].title)
-                    }
-                } else if (referenceID) {
-                    console.warn(`Could not find OVAL definition for ${referenceID}`)
-                }
-            }
-        }
-    
-        if (removeNewlines) {
-            const fix = removeXMLSpecialCharacters(rule.fixtext ? rule.fixtext[0]['#text'] : (rule.fix ? (rule.fix[0] as Notice)['#text'] || 'Missing fix text' : 'Missing fix text'))
-            control.descs.fix = fix.replace(/\n/g, '{{{{newlineHERE}}}}')
-        } else {
-            control.descs.fix = removeXMLSpecialCharacters(rule.fixtext ? rule.fixtext[0]['#text'] : (rule.fix ? (rule.fix[0] as Notice)['#text'] || 'Missing fix text' : 'Missing fix text'))
-        }
-        
-        control.tags.severity = impactNumberToSeverityString(severityStringToImpact(rule['@_severity'] || 'critical', control.id))
-        control.tags.gid = rule.group['@_id'],
-        control.tags.rid = rule['@_id']
-        control.tags.stig_id = rule['version']
-
-        if (typeof rule.group.title === "string") {
-            control.tags.gtitle = removeXMLSpecialCharacters(rule.group.title)
-        } else {
-            control.tags.gtitle = removeXMLSpecialCharacters(_.get(rule.group, 'title[0].#text'))
-        }
-        
-        if (rule['fix'] && rule['fix'].length > 0) {
-            control.tags.fix_id = rule['fix'][0]['@_id']
-        } else {
-            control.tags.fix_id = null
-        }
-
-        if (rule['rationale']) {
-            control.tags.rationale = rule['rationale'][0]['#text']
-        } else {
-            control.tags.rationale = null
-        }
-
-        if (typeof extractedDescription === 'object') {
-            control.tags.satisfies = extractedDescription.VulnDiscussion?.includes('Satisfies: ') && extractedDescription.VulnDiscussion.split('Satisfies: ').length >= 1 ? extractedDescription.VulnDiscussion.split('Satisfies: ')[1].split(',').map(satisfaction => satisfaction.trim()) : undefined
-            control.tags.false_negatives = extractedDescription.FalseNegatives || undefined
-            control.tags.false_positives = extractedDescription.FalsePositives || undefined
-            control.tags.documentable = typeof extractedDescription.Documentable === 'boolean' ? extractedDescription.Documentable : undefined
-            control.tags.mitigations = extractedDescription.Mitigations || undefined
-            control.tags.severity_override_guidance = extractedDescription.SeverityOverrideGuidance || undefined
-            control.tags.potential_impacts = extractedDescription.PotentialImpacts || undefined
-            control.tags.third_party_tools = extractedDescription.ThirdPartyTools || undefined
-            control.tags.mitigation_control = extractedDescription.MitigationControl || undefined
-            control.tags.mitigation_controls = extractedDescription.MitigationControls || undefined
-            control.tags.responsibility = extractedDescription.Responsibility || undefined
-            control.tags.ia_controls = extractedDescription.IAControls || undefined
-        }
-
-        control.tags = _.mapValues(_.omitBy(control.tags, (value) => value === undefined), (value) => {
-            if (typeof value === 'string') {
-                return removeXMLSpecialCharacters(value)
-            } else {
-                return value
-            }
-        })
-
-         // Get all identifiers from the rule
-         if (rule.ident) {
-            rule.ident.forEach((identifier) => {
-                // Get CCIs
-                if (identifier['@_system'].toLowerCase().includes('cci')) {
-                    if (!('cci' in control.tags)) {
-                        control.tags.cci = []
-                    }
-                    control.tags.cci?.push(identifier['#text'])
-                }
-                // Get legacy identifiers
-                else if (identifier['@_system'].toLowerCase().includes('legacy')) {
-                    if (!('legacy' in control.tags)) {
-                        control.tags.legacy = []
-                    }
-                    control.tags.legacy?.push(identifier['#text'])
-                }
-                // Get NIST identifiers
-                else if (identifier['@_system'].toLowerCase().includes('nist')) {
-                    if (!('nist' in control.tags)) {
-                        control.tags.nist = []
-                    }
-                    control.tags.nist?.push(identifier['#text'])
-                } else {
-                    // console.log('Alert')
-                    // console.log(identifier['@_system'])
-                    // console.log(identifier['#text'])
-                }
-            })
-        }
-
-        rule.reference?.forEach((reference) => {
-            if (_.get(reference, '@_href') === '') {
-                control.refs?.push(_.get(reference, '#text'))
-            } else {
-                try {
-                    const referenceText = _.get(reference, '#text') || ''
-                    const referenceURL = _.get(reference, '@_href') || ''
-                    if (referenceURL) {
-                        const parsedURL = new URL(_.get(reference, '@_href'))
-                        if (parsedURL.protocol.toLowerCase().includes('http') || parsedURL.protocol.toLowerCase().includes('https')) {
-                            control.refs?.push({
-                                ref: referenceText,
-                                url: referenceURL
-                            })
-                        } else {
-                            control.refs?.push({
-                                ref: referenceText,
-                                uri: referenceURL
-                            })
-                        }
-                    } else {
-                        if ('title' in reference) {
-                            control.refs?.push(_.get(reference, 'title') as string)
-                        }
-                    }
-
-                    // Add the reference to the control tags when seperated by §
-                    if (typeof referenceText === 'string' && referenceText.indexOf('§') !== -1) {
-                        const referenceParts = referenceText.split('§')
-                        if (referenceParts.length == 2) {
-                            let [identifierType, identifier] = referenceText.split('§')
-                            identifierType = identifierType.toLowerCase();
-                            if (!(identifierType in control.tags)) {
-                                control.tags[identifierType] = [identifier]
-                            } else if (Array.isArray(control.tags[identifierType])) {
-                                control.tags[identifierType] = _.union(control.tags[identifierType] as ArrayLike<string>, [identifier])
-                            } else {
-                                console.warn(`Attempted to push identifier to control tags when identifier already exists: ${identifierType}: ${identifier}`)
-                            }
-                        } else {
-                            console.warn("Reference parts of invalid length:")
-                            console.log(referenceParts)
-                        }
-                    }
-                } catch (e){
-                    console.warn(`Error parsing ref for control ${control.id}: `)
-                    console.warn(JSON.stringify(reference, null, 2))
-                    console.warn(e);
-                }
-            }
-        })
-
-        // Associate any CCIs with NIST tags
-        if (control.tags.cci) {
-            control.tags.cci.forEach((cci: string) => {
-                if (!('nist' in control.tags)) {
-                    control.tags.nist = []
-                }
-                if (cci in CciNistMappingData) {
-                    control.tags.nist?.push(_.get(CciNistMappingData, cci))
-                }
-            })
-        }
-
-        profile.controls.push(control)
-    })
-
-    profile.controls = _.sortBy(profile.controls, 'id')
-
-    return profile.toUnformattedObject()
-}

package/src/types/diff.d.ts

@@ -1,9 +0,0 @@
-import Control from "../objects/control"
-
-export type ProfileDiff = {
-    removedControlIDs: string[];
-    addedControlIDs: string[];
-    changedControls: {
-        [key: string]: Partial<Control>;
-    }
-}