@mitre/inspec-objects 0.0.4 → 0.0.7

package/lib/objects/control.d.ts

@@ -1,10 +1,15 @@
 import { ExecJSON } from "inspecjs";
+export declare function objectifyDescriptions(descs: ExecJSON.ControlDescription[] | {
+    [key: string]: string | undefined;
+} | null | undefined): {
+    [key: string]: string | undefined;
+} | null | undefined;
 export default class Control {
     id?: string | null;
     title?: string | null;
     code?: string | null;
     desc?: string | null;
-    descs?: ExecJSON.ControlDescription[] | {
+    descs?: {
         [key: string]: string | undefined;
     } | null;
     impact?: number;

package/lib/objects/control.js

@@ -1,9 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectifyDescriptions = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const flat_1 = require("flat");
 const global_1 = require("../utilities/global");
+function objectifyDescriptions(descs) {
+    if (Array.isArray(descs)) {
+        const descriptions = {};
+        descs.forEach((description) => {
+            descriptions[description.label] = description.data;
+        });
+        return descriptions;
+    }
+    return descs;
+}
+exports.objectifyDescriptions = objectifyDescriptions;
 class Control {
     constructor(data) {
         this.tags = {};
@@ -28,13 +40,13 @@ class Control {
         let result = "# encoding: UTF-8\n\n";
         result += `control "${this.id}" do\n`;
         if (this.title) {
-            result += `  title "${(0, global_1.wrapAndEscapeQuotes)(this.title, lineLength)}"\n`;
+            result += `  title "${(0, global_1.wrapAndEscapeQuotes)((0, global_1.removeNewlinePlaceholders)(this.title), lineLength)}"\n`;
         }
         else {
             console.error(`${this.id} does not have a title`);
         }
         if (this.desc) {
-            result += `  desc "${(0, global_1.wrapAndEscapeQuotes)(this.desc, lineLength)}"\n`;
+            result += `  desc "${(0, global_1.wrapAndEscapeQuotes)((0, global_1.removeNewlinePlaceholders)(this.desc), lineLength)}"\n`;
         }
         else {
             console.error(`${this.id} does not have a desc`);
@@ -42,7 +54,7 @@ class Control {
         if (this.descs) {
             Object.entries(this.descs).forEach(([key, desc]) => {
                 if (desc) {
-                    result += `  desc "${key}", "${(0, global_1.wrapAndEscapeQuotes)(desc, lineLength)}"\n`;
+                    result += `  desc "${key}", "${(0, global_1.wrapAndEscapeQuotes)((0, global_1.removeNewlinePlaceholders)(desc), lineLength)}"\n`;
                 }
                 else {
                     console.error(`${this.id} does not have a desc for the value ${key}`);
@@ -58,10 +70,10 @@ class Control {
         if (this.refs) {
             this.refs.forEach((ref) => {
                 if (typeof ref === 'string') {
-                    result += `  ref '${(0, global_1.escapeQuotes)(ref)}'\n`;
+                    result += `  ref '${(0, global_1.escapeQuotes)((0, global_1.removeNewlinePlaceholders)(ref))}'\n`;
                 }
                 else {
-                    result += `  ref '${(0, global_1.escapeQuotes)(ref.ref || '')}', url: '${(0, global_1.escapeQuotes)(ref.url || '')}'`;
+                    result += `  ref '${(0, global_1.escapeQuotes)((0, global_1.removeNewlinePlaceholders)(ref.ref || ''))}', url: '${(0, global_1.escapeQuotes)((0, global_1.removeNewlinePlaceholders)(ref.url || ''))}'`;
                 }
             });
         }
@@ -84,7 +96,7 @@ class Control {
                     }
                 }
                 else if (typeof value === "string") {
-                    result += `  tag ${tag}: "${(0, global_1.wrapAndEscapeQuotes)(value, lineLength)}"\n`;
+                    result += `  tag ${tag}: "${(0, global_1.wrapAndEscapeQuotes)((0, global_1.removeNewlinePlaceholders)(value), lineLength)}"\n`;
                 }
             }
         });

package/lib/parsers/json.js

@@ -4,7 +4,7 @@ exports.processJSON = exports.processExecJSON = exports.processProfileJSON = exp
 const tslib_1 = require("tslib");
 const inspecjs_1 = require("inspecjs");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const control_1 = tslib_1.__importDefault(require("../objects/control"));
+const control_1 = tslib_1.__importStar(require("../objects/control"));
 const profile_1 = tslib_1.__importDefault(require("../objects/profile"));
 function processEvaluation(evaluationInput) {
     const topLevelProfile = evaluationInput.contains[0];
@@ -25,7 +25,7 @@ function processEvaluation(evaluationInput) {
             title: control.data.title,
             impact: control.data.impact,
             desc: control.data.desc,
-            descs: control.hdf.wraps.descriptions,
+            descs: (0, control_1.objectifyDescriptions)(control.hdf.wraps.descriptions),
             tags: control.hdf.wraps.tags,
         }));
     });
@@ -52,7 +52,7 @@ function processProfileJSON(profileInput) {
             impact: control.impact,
             code: control.code,
             tags: control.tags,
-            descs: control.descriptions,
+            descs: (0, control_1.objectifyDescriptions)(control.descriptions),
         }));
     });
     return profile;

package/lib/parsers/xccdf.d.ts

@@ -5,4 +5,4 @@ export declare type GroupContextualizedRule = BenchmarkRule & {
     group: Omit<BenchmarkGroup, 'Rule' | 'Group'>;
 };
 export declare function extractAllRules(groups: BenchmarkGroup[]): GroupContextualizedRule[];
-export declare function processXCCDF(xml: string, removeNewlines?: boolean, ovalDefinitions?: Record<string, OvalDefinitionValue>): Profile;
+export declare function processXCCDF(xml: string, removeNewlines: boolean | undefined, useRuleId: 'group' | 'rule' | 'version', ovalDefinitions?: Record<string, OvalDefinitionValue>): Profile;

package/lib/parsers/xccdf.js

@@ -25,7 +25,7 @@ function extractAllRules(groups) {
     return rules;
 }
 exports.extractAllRules = extractAllRules;
-function processXCCDF(xml, removeNewlines = false, ovalDefinitions) {
+function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
     const parsedXML = (0, xccdf_1.convertEncodedXmlIntoJson)(xml);
     const rules = extractAllRules(parsedXML.Benchmark[0].Group);
     const profile = new profile_1.default({
@@ -43,7 +43,19 @@ function processXCCDF(xml, removeNewlines = false, ovalDefinitions) {
             extractedDescription = (0, xccdf_1.convertEncodedHTMLIntoJson)(rule.description);
         }
         const control = new control_1.default();
-        control.id = rule['@_id'];
+        switch (useRuleId) {
+            case 'group':
+                control.id = rule.group['@_id'];
+                break;
+            case 'rule':
+                control.id = rule['@_id'].split('r')[0];
+                break;
+            case 'version':
+                control.id = rule.version;
+                break;
+            default:
+                throw new Error('useRuleId must be one of "group", "rule", or "version"');
+        }
         if (removeNewlines) {
             const title = (0, xccdf_1.removeXMLSpecialCharacters)(rule['@_severity'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${rule.title}`);
             control.title = title.replace(/\n/g, '{{{{newlineHERE}}}}');

package/lib/utilities/diff.js

@@ -49,10 +49,8 @@ function diffProfile(fromProfile, toProfile) {
         const toControl = toProfile.controls.find((control) => control.id === fromControl.id);
         if (toControl) {
             const controlDiff = (0, json_diff_1.diff)(fromControl, toControl);
-            console.log(controlDiff);
             if (controlDiff) {
                 Object.entries(controlDiff).forEach(([key, value]) => {
-                    console.log(value);
                     if (lodash_1.default.has(value, '__new')) {
                         lodash_1.default.set(profileDiff, 'changedControls.' + fromControl.id + '.' + key.replace('.', '\\.'), lodash_1.default.get(controlDiff, key + '.__new'));
                     }

package/lib/utilities/global.d.ts

@@ -4,5 +4,6 @@ declare const escapeQuotes: (s: string) => string;
 declare const escapeDoubleQuotes: (s: string) => string;
 declare const wrapAndEscapeQuotes: (s: string, lineLength?: number) => string;
 export { escapeQuotes, escapeDoubleQuotes, wrapAndEscapeQuotes };
+export declare function removeNewlinePlaceholders(s: string): string;
 export declare function getFirstPath(object: Record<string, unknown>, paths: string[]): string;
 export declare function hasPath(file: Record<string, unknown>, path: string | string[]): boolean;

package/lib/utilities/global.js

@@ -1,11 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasPath = exports.getFirstPath = exports.wrapAndEscapeQuotes = exports.escapeDoubleQuotes = exports.escapeQuotes = exports.unformatText = exports.wrap = void 0;
+exports.hasPath = exports.getFirstPath = exports.removeNewlinePlaceholders = exports.wrapAndEscapeQuotes = exports.escapeDoubleQuotes = exports.escapeQuotes = exports.unformatText = exports.wrap = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 // Breaks lines down to lineLength number of characters
 function wrap(s, lineLength = 80) {
-    return s.replace(new RegExp(`(?![^\n]{1,${lineLength}}$)([^\n]{1,${lineLength}})`, "g"), "$1\n");
+    let newString = "";
+    let currentLine = "";
+    let currentLength = 0;
+    let shouldBreakLine = false;
+    for (var i = 0; i < s.length; i++) {
+        if (shouldBreakLine) {
+            newString += `\n`;
+            currentLength = 0;
+            shouldBreakLine = false;
+        }
+        let currentChar = s.charAt(i);
+        let nextChar = s.charAt(i + 1);
+        if (nextChar === " ") {
+            if (currentLength >= lineLength) {
+                shouldBreakLine = true;
+                newString += currentChar;
+                currentLength++;
+            }
+            else {
+                newString += currentChar;
+                currentLength++;
+            }
+        }
+        else {
+            newString += currentChar;
+            currentLength++;
+        }
+    }
+    return newString;
 }
 exports.wrap = wrap;
 function unformatText(s) {
@@ -18,6 +46,10 @@ const escapeDoubleQuotes = (s) => s.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
 exports.escapeDoubleQuotes = escapeDoubleQuotes;
 const wrapAndEscapeQuotes = (s, lineLength) => escapeDoubleQuotes(wrap(s, lineLength)); // Escape backslashes and quotes, and wrap long lines
 exports.wrapAndEscapeQuotes = wrapAndEscapeQuotes;
+function removeNewlinePlaceholders(s) {
+    return s.replace(/\{\{\{\{newlineHERE\}\}\}\}/g, '\n');
+}
+exports.removeNewlinePlaceholders = removeNewlinePlaceholders;
 function getFirstPath(object, paths) {
     const index = lodash_1.default.findIndex(paths, (p) => hasPath(object, p));
     if (index === -1) {

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@mitre/inspec-objects",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@mitre/inspec-objects",
-      "version": "0.0.1",
+      "version": "0.0.3",
       "license": "Apache-2.0",
       "dependencies": {
         "@types/flat": "^5.0.2",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitre/inspec-objects",
-  "version": "0.0.4",
+  "version": "0.0.7",
   "description": "Typescript objects for normalizing between InSpec profiles and XCCDF benchmarks",
   "main": "lib/index.js",
   "publishConfig": {