@mitre/inspec-objects 0.0.1

package/src/utilities/xccdf.ts

@@ -0,0 +1,110 @@
+import parser from 'fast-xml-parser'
+import * as htmlparser from 'htmlparser2'
+import _ from 'lodash'
+import { DecodedDescription } from '../types/xccdf'
+
+export function convertEncodedXmlIntoJson(
+    encodedXml: string,
+  ): any {
+    return parser.parse(encodedXml, {
+      ignoreAttributes: false,
+      attributeNamePrefix: '@_',
+    })
+}
+
+export function severityStringToImpact(string: 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
+  }
+
+  throw new Error(`${string}' is not a valid severity value. It should be one of the approved keywords`)
+}
+
+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/test/sample_data/inspec/profiles/redhat-enterprise-linux-7-stig-baseline/spec/fixtures/kitchen/manifests/site.pp

@@ -0,0 +1,29 @@
+package { 'screen':
+  ensure => 'installed',
+  tag => 'V-71897'
+}
+
+Package {
+  ensure => 'installed'
+}
+$mfa = ['esc','pam_pkcs11','authconfig-gtk']
+package {
+  $mfa: tag => 'V-72417'
+}
+
+sysctl { 'net.ipv4.conf.all.accept_redirects':
+  ensure => present,
+  value  => '0',
+  tag => 'V-73175'
+}
+
+sysctl { 'net.ipv6.conf.all.accept_source_route':
+  ensure => present,
+  value  => '0',
+  tag => 'V-72319'
+}
+
+package { 'sssd':
+  ensure => 'installed',
+  tag => 'V-72427'
+}

package/tsconfig.build.json

@@ -0,0 +1,5 @@
+
+{
+    "extends": "./tsconfig.json",
+    "exclude": ["**/*.spec.ts", "lib", "test"]
+  }

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+    "compilerOptions": {
+      "module": "commonjs",
+      "moduleResolution": "node",
+      "noImplicitAny": true,
+      "resolveJsonModule": true,
+      "declaration": true,
+      "importHelpers": true,
+      "esModuleInterop": true,
+      "outDir": "lib",
+      "rootDir": "src",
+      "strict": true,
+      "target": "es2019",
+      "types": ["node", "jest"]
+    },
+    "include": [
+      "index.ts",
+      "src/**/*"
+    ],
+  }
+