@mitre/inspec-objects 0.0.5 → 0.0.8

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;
@@ -16,14 +21,15 @@ export default class Control {
     })[];
     tags: {
         check?: string;
+        check_id?: string;
         fix?: string;
+        fix_id?: string | null;
         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[];

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 = {};

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.js

@@ -43,13 +43,12 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, 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'];
+                control.id = rule['@_id'].split('r')[0];
                 break;
             case 'version':
                 control.id = rule.version;
@@ -126,15 +125,9 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
         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 = ((_c = extractedDescription.VulnDiscussion) === null || _c === void 0 ? void 0 : _c.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;

package/lib/utilities/diff.d.ts

@@ -1,4 +1,5 @@
 import Profile from '../objects/profile';
 import { ProfileDiff } from '../types/diff';
 export declare function removeNewlines(control?: Record<string, unknown>): Record<string, unknown>;
+export declare function simplifyDiff(diffData: Record<string, unknown>): Record<string, unknown>;
 export declare function diffProfile(fromProfile: Profile, toProfile: Profile): ProfileDiff;

package/lib/utilities/diff.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.diffProfile = exports.removeNewlines = void 0;
+exports.diffProfile = exports.simplifyDiff = exports.removeNewlines = void 0;
 const tslib_1 = require("tslib");
 const json_diff_1 = require("json-diff");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
@@ -19,6 +19,26 @@ function removeNewlines(control) {
     });
 }
 exports.removeNewlines = removeNewlines;
+function simplifyDiff(diffData) {
+    return lodash_1.default.transform(diffData, (result, diffValue, key) => {
+        if (lodash_1.default.has(diffValue, '__new')) {
+            result[key] = lodash_1.default.get(diffValue, '__new');
+        }
+        else if (Array.isArray(diffValue)) {
+            result[key] = diffValue.map((value) => value[0] === '+' && value[1]).filter(value => value);
+        }
+        else if (typeof diffValue === 'object') {
+            result[key] = simplifyDiff(diffValue);
+        }
+        else if (key.endsWith('__deleted')) {
+            return undefined;
+        }
+        else {
+            result[key] = diffValue;
+        }
+    });
+}
+exports.simplifyDiff = simplifyDiff;
 function diffProfile(fromProfile, toProfile) {
     const profileDiff = {
         addedControlIDs: [],
@@ -48,18 +68,9 @@ function diffProfile(fromProfile, toProfile) {
     for (const fromControl of fromProfile.controls) {
         const toControl = toProfile.controls.find((control) => control.id === fromControl.id);
         if (toControl) {
-            const controlDiff = (0, json_diff_1.diff)(fromControl, toControl);
+            const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(fromControl, toControl), 'code__deleted');
             if (controlDiff) {
-                Object.entries(controlDiff).forEach(([key, 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'));
-                    }
-                    else if (typeof value === 'object') {
-                        Object.entries(value).forEach(([subKey]) => {
-                            lodash_1.default.set(profileDiff, 'changedControls.' + fromControl.id + '.' + key.replace('.', '\\.') + '.' + subKey.replace('.', '\\.'), lodash_1.default.get(controlDiff, key + '.' + subKey + '.__new'));
-                        });
-                    }
-                });
+                profileDiff.changedControls[toControl.id] = simplifyDiff(controlDiff);
             }
         }
     }

package/package.json

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