@mitre/inspec-objects 0.0.13 → 0.0.16

package/lib/objects/control.d.ts

@@ -3,15 +3,16 @@ 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;
+    id: string;
     title?: string | null;
     code?: string | null;
+    describe?: string | null;
     desc?: string | null;
-    descs?: {
+    descs: {
         [key: string]: string | undefined;
-    } | null;
+    };
     impact?: number;
     ref?: string;
     refs?: (string | {

package/lib/objects/control.js

@@ -13,7 +13,7 @@ function objectifyDescriptions(descs) {
         });
         return descriptions;
     }
-    return descs;
+    return descs || {};
 }
 exports.objectifyDescriptions = objectifyDescriptions;
 class Control {
@@ -31,7 +31,7 @@ class Control {
         const flattened = (0, flat_1.flatten)(this);
         Object.entries(flattened).forEach(([key, value]) => {
             if (typeof value === 'string') {
-                lodash_1.default.set(flattened, key, (0, global_1.unformatText)(value));
+                lodash_1.default.set(flattened, key, value);
             }
         });
         return new Control((0, flat_1.unflatten)(flattened));
@@ -40,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)((0, global_1.removeNewlinePlaceholders)(this.title), lineLength)}"\n`;
+            result += `  title "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(this.title))}"\n`;
         }
         else {
             console.error(`${this.id} does not have a title`);
         }
         if (this.desc) {
-            result += `  desc "${(0, global_1.wrapAndEscapeQuotes)((0, global_1.removeNewlinePlaceholders)(this.desc), lineLength)}"\n`;
+            result += `  desc "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(this.desc))}"\n`;
         }
         else {
             console.error(`${this.id} does not have a desc`);
@@ -54,7 +54,7 @@ class Control {
         if (this.descs) {
             Object.entries(this.descs).forEach(([key, desc]) => {
                 if (desc) {
-                    result += `  desc "${key}", "${(0, global_1.wrapAndEscapeQuotes)((0, global_1.removeNewlinePlaceholders)(desc), lineLength)}"\n`;
+                    result += `  desc "${key}", "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(desc))}"\n`;
                 }
                 else {
                     console.error(`${this.id} does not have a desc for the value ${key}`);
@@ -81,7 +81,7 @@ class Control {
             if (value) {
                 if (typeof value === "object") {
                     if (Array.isArray(value) && typeof value[0] === "string") {
-                        result += `  tag ${tag}: ${JSON.stringify(value)}\n`;
+                        result += `  tag ${tag}: ${JSON.stringify(value).split('","').join('", "')}\n`;
                     }
                     else {
                         // Convert JSON Object to Ruby Hash
@@ -96,10 +96,14 @@ class Control {
                     }
                 }
                 else if (typeof value === "string") {
-                    result += `  tag ${tag}: "${(0, global_1.wrapAndEscapeQuotes)((0, global_1.removeNewlinePlaceholders)(value), lineLength)}"\n`;
+                    result += `  tag ${tag}: "${(0, global_1.escapeDoubleQuotes)((0, global_1.removeNewlinePlaceholders)(value))}"\n`;
                 }
             }
         });
+        if (this.describe) {
+            result += '\n';
+            result += this.describe;
+        }
         result += "end";
         return result;
     }

package/lib/parsers/json.js

@@ -45,7 +45,7 @@ function processProfileJSON(profileInput) {
         version: profileInput.data.version,
     });
     profileInput.data.controls.forEach((control) => {
-        profile.controls.push(new control_1.default({
+        const newControl = new control_1.default({
             id: control.id,
             title: control.title,
             desc: control.desc,
@@ -53,7 +53,17 @@ function processProfileJSON(profileInput) {
             code: control.code,
             tags: control.tags,
             descs: (0, control_1.objectifyDescriptions)(control.descriptions),
-        }));
+        });
+        // Migrate check and fix text from tags to descriptions
+        if (newControl.tags.check && !newControl.descs.check) {
+            lodash_1.default.set(newControl.descs, 'check', control.tags.check);
+            lodash_1.default.set(newControl.tags, 'check', undefined);
+        }
+        if (newControl.tags.fix && !newControl.descs.fix) {
+            lodash_1.default.set(newControl.descs, 'fix', control.tags.fix);
+            lodash_1.default.set(newControl.tags, 'fix', undefined);
+        }
+        profile.controls.push(newControl);
     });
     return profile;
 }

package/lib/parsers/xccdf.js

@@ -37,7 +37,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
         summary: parsedXML.Benchmark[0].description[0]['#text']
     });
     rules.forEach(rule => {
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         let extractedDescription;
         if (Array.isArray(rule.description)) {
             extractedDescription = rule.description[0]['#text'];
@@ -68,29 +68,16 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
             default:
                 throw new Error('useRuleId must be one of "group", "rule", or "version"');
         }
-        if (removeNewlines) {
-            const title = (0, xccdf_1.removeXMLSpecialCharacters)(rule['@_severity'] ? ensureDecodedXMLStringValue(rule.title) : `[[[MISSING SEVERITY FROM STIG]]] ${ensureDecodedXMLStringValue(rule.title)}`);
-            control.title = title.replace(/\n/g, '{{{{newlineHERE}}}}');
-            const desc = (0, xccdf_1.removeXMLSpecialCharacters)(typeof extractedDescription === 'string' ? extractedDescription : ((_a = extractedDescription.VulnDiscussion) === null || _a === void 0 ? void 0 : _a.split('Satisfies: ')[0]) || 'Missing Description');
-            control.desc = desc === null || desc === void 0 ? void 0 : desc.trim().replace(/\n/g, '{{{{newlineHERE}}}}');
-        }
-        else {
-            control.title = (0, xccdf_1.removeXMLSpecialCharacters)(rule['@_severity'] ? ensureDecodedXMLStringValue(rule.title) : `[[[MISSING SEVERITY FROM STIG]]] ${ensureDecodedXMLStringValue(rule.title)}`);
-            control.desc = (0, xccdf_1.removeXMLSpecialCharacters)(typeof extractedDescription === 'string' ? extractedDescription : ((_b = extractedDescription.VulnDiscussion) === null || _b === void 0 ? void 0 : _b.split('Satisfies: ')[0]) || 'Missing Description');
-        }
-        control.impact = (0, xccdf_1.severityStringToImpact)(rule['@_severity'] || 'critical', rule.group['@_id']);
+        control.title = (0, xccdf_1.removeXMLSpecialCharacters)(rule['@_severity'] ? ensureDecodedXMLStringValue(rule.title) : `[[[MISSING SEVERITY FROM STIG]]] ${ensureDecodedXMLStringValue(rule.title)}`);
+        control.desc = (0, xccdf_1.removeXMLSpecialCharacters)(typeof extractedDescription === 'string' ? extractedDescription : ((_a = extractedDescription.VulnDiscussion) === null || _a === void 0 ? void 0 : _a.split('Satisfies: ')[0]) || 'Missing Description');
+        control.impact = (0, xccdf_1.severityStringToImpact)(rule['@_severity'] || 'medium', 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 = (0, xccdf_1.removeXMLSpecialCharacters)(rule.check ? rule.check[0]['check-content'] : 'Missing description');
-                    control.descs.check = check.replace(/\n/g, '{{{{newlineHERE}}}}');
-                }
-                else {
-                    control.descs.check = (0, xccdf_1.removeXMLSpecialCharacters)(rule.check ? rule.check[0]['check-content'] : 'Missing description');
-                }
+                control.descs.check = (0, xccdf_1.removeXMLSpecialCharacters)(rule.check ? rule.check[0]['check-content'] : 'Missing description');
+                control.tags.check_id = rule.check[0]['@_system'];
             }
             else if (rule.check.some((ruleValue) => 'check-content-ref' in ruleValue) && ovalDefinitions) {
                 let referenceID = null;
@@ -104,26 +91,14 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                     }
                 }
                 if (referenceID && referenceID in ovalDefinitions) {
-                    if (removeNewlines) {
-                        const check = (0, xccdf_1.removeXMLSpecialCharacters)(ovalDefinitions[referenceID].metadata[0].title);
-                        control.descs.check = check.replace(/\n/g, '{{{{newlineHERE}}}}');
-                    }
-                    else {
-                        control.descs.check = (0, xccdf_1.removeXMLSpecialCharacters)(ovalDefinitions[referenceID].metadata[0].title);
-                    }
+                    control.descs.check = (0, xccdf_1.removeXMLSpecialCharacters)(ovalDefinitions[referenceID].metadata[0].title);
                 }
                 else if (referenceID) {
                     console.warn(`Could not find OVAL definition for ${referenceID}`);
                 }
             }
         }
-        if (removeNewlines) {
-            const fix = (0, xccdf_1.removeXMLSpecialCharacters)(rule.fixtext ? rule.fixtext[0]['#text'] : (rule.fix ? rule.fix[0]['#text'] || 'Missing fix text' : 'Missing fix text'));
-            control.descs.fix = fix.replace(/\n/g, '{{{{newlineHERE}}}}');
-        }
-        else {
-            control.descs.fix = (0, xccdf_1.removeXMLSpecialCharacters)(rule.fixtext ? rule.fixtext[0]['#text'] : (rule.fix ? rule.fix[0]['#text'] || 'Missing fix text' : 'Missing fix text'));
-        }
+        control.descs.fix = (0, xccdf_1.removeXMLSpecialCharacters)(rule.fixtext ? rule.fixtext[0]['#text'] : (rule.fix ? rule.fix[0]['#text'] || 'Missing fix text' : 'Missing fix text'));
         control.tags.severity = (0, xccdf_1.impactNumberToSeverityString)((0, xccdf_1.severityStringToImpact)(rule['@_severity'] || 'critical', control.id || 'Unknown'));
         control.tags.gid = rule.group['@_id'],
             control.tags.rid = rule['@_id'];
@@ -141,7 +116,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
             control.tags.rationale = rule['rationale'][0]['#text'];
         }
         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.satisfies = ((_b = extractedDescription.VulnDiscussion) === null || _b === void 0 ? void 0 : _b.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;
@@ -187,14 +162,9 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                     }
                     (_c = control.tags.nist) === null || _c === void 0 ? void 0 : _c.push(identifier['#text']);
                 }
-                else {
-                    // console.log('Alert')
-                    // console.log(identifier['@_system'])
-                    // console.log(identifier['#text'])
-                }
             });
         }
-        (_d = rule.reference) === null || _d === void 0 ? void 0 : _d.forEach((reference) => {
+        (_c = rule.reference) === null || _c === void 0 ? void 0 : _c.forEach((reference) => {
             var _a, _b, _c, _d;
             if (lodash_1.default.get(reference, '@_href') === '') {
                 (_a = control.refs) === null || _a === void 0 ? void 0 : _a.push(lodash_1.default.get(reference, '#text'));

package/lib/resources/automatticUpdateTemplate.json

@@ -1,3 +1,3 @@
 {
-    "data": "## Automattic Update: {{fromVersion}} -> {{toVersion}}\n\n### New Controls:\n{{#addedControls}}\n+   {{id}} - {{title}}\n{{/addedControls}}\n\n### Updated Check/Fixes:\n#### Checks:\n\n{{#checks}}\n{{id}}:\n```\n{{{check}}}\n```\n\n\n{{/checks}}"
+    "data": "## Automatic Update: {{fromVersion}} -> {{toVersion}}\n\n### New Controls:\n{{#addedControls}}\n+   {{id}} - {{title}}\n{{/addedControls}}\n\n{{#hasRenamedControls}}\n### Updated Control IDs:\n<details>\n  <summary>Click to expand.</summary>\n  \n  {{#renamedControls}}\n -  {{oldId}} -> {{newId}}\n  {{/renamedControls}} \n</details>\n{{/hasRenamedControls}}\n\n### Updated Check/Fixes:\n#### Checks:\n<details open>\n  <summary>Click to expand.</summary>\n{{#updatedChecks}}\n{{id}}:\nOld: \n```\n{{{old}}}\n\n```\n\nUpdated:\n```\n{{{new}}}\n\n```\n---\n{{/updatedChecks}}\n</details>\n\n#### Fixes:\n<details open>\n  <summary>Click to expand.</summary>\n{{#updatedFixes}}\n{{id}}:\nOld: \n```\n{{{old}}}\n\n```\nNew:\n```\n{{{new}}}\n\n```\n---\n{{/updatedFixes}}\n</details>\n\n### Updated Impacts\n<details open>\n  <summary>Click to expand.</summary>\n{{#updatedImpacts}}\n{{id}}:\nOld: {{old}}\nNew: {{new}}\n---\n{{/updatedImpacts}}\n</details>\n\n### Updated Titles\n<details>\n  <summary>Click to expand.</summary>\n{{#updatedTitles}}\n{{id}}:\nOld: {{old}}\nNew: {{new}}\n---\n{{/updatedTitles}}\n</details>\n\n### Updated Descriptions\n<details>\n  <summary>Click to expand.</summary>\n{{#updatedDescriptions}}\n{{id}}:\nOld:\n```\n{{{old}}}\n\n```\nNew:\n```\n{{{new}}}\n\n```\n---\n{{/updatedDescriptions}}\n</details>"
 }

package/lib/utilities/diff.d.ts

@@ -1,8 +1,9 @@
-import Profile from '../objects/profile';
-import { ProfileDiff } from '../types/diff';
+import Profile from "../objects/profile";
+import { ProfileDiff } from "../types/diff";
+import winston from "winston";
 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): {
+export declare function diffProfile(fromProfile: Profile, toProfile: Profile, logger: winston.Logger): {
     simplified: ProfileDiff;
     originalDiff: Record<string, unknown>;
 };

package/lib/utilities/diff.js

@@ -4,15 +4,16 @@ 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"));
+const update_1 = require("./update");
 function removeNewlines(control) {
     if (!control) {
         return {};
     }
     return lodash_1.default.mapValues(control, (value) => {
-        if (typeof value === 'string') {
-            return value.replace(/\n/g, '{{{{newlineHERE}}}}').trim();
+        if (typeof value === "string") {
+            return value.replace(/\n/g, "{{{{newlineHERE}}}}").trim();
         }
-        else if (typeof value === 'object' && value !== null) {
+        else if (typeof value === "object" && value !== null) {
             return removeNewlines(value);
         }
         return value;
@@ -21,24 +22,28 @@ 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')) {
+        if (lodash_1.default.has(diffValue, "__new")) {
             // Remove any trailing space
-            if (typeof lodash_1.default.get(diffValue, '__new') === 'string' && typeof lodash_1.default.get(diffValue, '__old') === 'string') {
-                if (lodash_1.default.get(diffValue, '__new').trim() !== lodash_1.default.get(diffValue, '__old').trim()) {
-                    lodash_1.default.set(result, key, lodash_1.default.get(diffValue, '__new'));
+            if (typeof lodash_1.default.get(diffValue, "__new") === "string" &&
+                typeof lodash_1.default.get(diffValue, "__old") === "string") {
+                if (lodash_1.default.get(diffValue, "__new").trim() !==
+                    lodash_1.default.get(diffValue, "__old").trim()) {
+                    lodash_1.default.set(result, key, lodash_1.default.get(diffValue, "__new"));
                 }
             }
             else {
-                result[key] = lodash_1.default.get(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);
+            result[key] = diffValue
+                .map((value) => value[0] === "+" && value[1])
+                .filter((value) => value);
         }
-        else if (typeof diffValue === 'object') {
+        else if (typeof diffValue === "object") {
             result[key] = simplifyDiff(diffValue);
         }
-        else if (key.endsWith('__deleted')) {
+        else if (key.endsWith("__deleted")) {
             return undefined;
         }
         else {
@@ -47,37 +52,62 @@ function simplifyDiff(diffData) {
     });
 }
 exports.simplifyDiff = simplifyDiff;
-function diffProfile(fromProfile, toProfile) {
+function diffProfile(fromProfile, toProfile, logger) {
     const profileDiff = {
         addedControlIDs: [],
         removedControlIDs: [],
+        renamedControlIds: {},
         addedControls: {},
-        changedControls: {}
+        changedControls: {},
     };
     const originalDiff = {
         addedControlIDs: [],
         removedControlIDs: [],
+        renamedControlIds: {},
         addedControls: {},
-        changedControls: {}
+        changedControls: {},
     };
-    const fromControlIDs = fromProfile.controls.map((control) => control.id).sort();
+    const fromControlIDs = fromProfile.controls
+        .map((control) => control.id)
+        .sort();
     const toControlIDs = toProfile.controls.map((control) => control.id).sort();
     // Find new controls
     const controlIDDiff = (0, json_diff_1.diff)(fromControlIDs, toControlIDs);
+    // Contains the new IDs
+    const changedControlIds = [];
     controlIDDiff === null || controlIDDiff === void 0 ? void 0 : controlIDDiff.forEach((diffValue) => {
-        if (diffValue[0] === '-') {
-            profileDiff.removedControlIDs.push(diffValue[1]);
-            originalDiff.removedControlIDs.push(diffValue[1]);
+        if (diffValue[0] === "-") {
+            const existingControl = fromProfile.controls.find((control) => control.id === diffValue[1]);
+            // Check if the control has been given a new ID
+            if (existingControl) {
+                const newControl = (0, update_1.findUpdatedControlByAllIdentifiers)(existingControl, toProfile.controls);
+                if (newControl && newControl.id !== existingControl.id) {
+                    profileDiff.renamedControlIds[existingControl.id] = newControl.id;
+                    originalDiff.renamedControlIds[existingControl.id] = newControl.id;
+                    changedControlIds.push(newControl.id.toLowerCase());
+                    const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(existingControl, newControl), "code__deleted");
+                    profileDiff.changedControls[newControl.id] = simplifyDiff(controlDiff);
+                    originalDiff.changedControls[newControl.id] = controlDiff;
+                    logger.verbose(`Control ${existingControl.id} has been upgraded to ${newControl.id}`);
+                }
+                else {
+                    profileDiff.removedControlIDs.push(diffValue[1]);
+                    originalDiff.removedControlIDs.push(diffValue[1]);
+                }
+            }
+            else {
+                logger.error(`Unable to find existing control ${diffValue[1]}`);
+            }
         }
-        else if (diffValue[0] === '+') {
+        else if (diffValue[0] === "+" && !changedControlIds.includes(diffValue[1].toLowerCase())) {
             profileDiff.addedControlIDs.push(diffValue[1]);
             originalDiff.addedControlIDs.push(diffValue[1]);
         }
     });
-    // Add new controls to changedControls
+    // Add new controls to addedControls
     profileDiff.addedControlIDs.forEach((addedControl) => {
         const newControl = toProfile.controls.find((control) => addedControl === control.id);
-        if (newControl) {
+        if (newControl && !profileDiff.changedControls[newControl.id]) {
             profileDiff.addedControls[addedControl] = newControl;
             originalDiff.addedControls[addedControl] = newControl;
         }
@@ -86,7 +116,7 @@ function diffProfile(fromProfile, toProfile) {
     for (const fromControl of fromProfile.controls) {
         const toControl = toProfile.controls.find((control) => control.id === fromControl.id);
         if (toControl) {
-            const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(fromControl, toControl), 'code__deleted');
+            const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(fromControl, toControl), "code__deleted");
             if (controlDiff) {
                 profileDiff.changedControls[toControl.id] = simplifyDiff(controlDiff);
                 originalDiff.changedControls[toControl.id] = controlDiff;

package/lib/utilities/diffMarkdown.d.ts

@@ -1,5 +1,5 @@
 import { ProfileDiff } from "../types/diff";
-import Profile from '../objects/profile';
+import Profile from "../objects/profile";
 export declare function createDiffMarkdown(diff: {
     simplified: ProfileDiff;
     originalDiff: any;

package/lib/utilities/diffMarkdown.js

@@ -4,26 +4,87 @@ exports.createDiffMarkdown = void 0;
 const tslib_1 = require("tslib");
 const mustache_1 = tslib_1.__importDefault(require("mustache"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const global_1 = require("./global");
-const xccdf_1 = require("./xccdf");
 const automatticUpdateTemplate_json_1 = tslib_1.__importDefault(require("../resources/automatticUpdateTemplate.json"));
 function getUpdatedCheckForId(id, profile) {
     const foundControl = profile.controls.find((control) => control.id === id);
-    return lodash_1.default.get(foundControl === null || foundControl === void 0 ? void 0 : foundControl.descs, 'check') || 'Missing check';
+    return lodash_1.default.get(foundControl === null || foundControl === void 0 ? void 0 : foundControl.descs, "check") || "Missing check";
 }
 function createDiffMarkdown(diff, updatedProfile) {
     const renderableDiffData = {
         addedControls: Object.values(diff.simplified.addedControls),
-        checks: [],
-        fixes: [],
+        hasRenamedControls: false,
+        renamedControls: [],
+        updatedChecks: [],
+        updatedFixes: [],
+        updatedImpacts: [],
+        updatedTitles: [],
+        updatedDescriptions: [],
     };
-    Object.entries(diff.simplified.changedControls).forEach(([id, updatedControl]) => {
-        if (lodash_1.default.get(updatedControl, "descs.check")) {
-            // console.log(removeXMLSpecialCharacters(removeNewlinePlaceholders(getUpdatedCheckForId(id, updatedProfile))))
-            renderableDiffData.checks.push({
-                id,
-                check: (0, xccdf_1.removeXMLSpecialCharacters)((0, global_1.removeNewlinePlaceholders)(getUpdatedCheckForId(id, updatedProfile))),
-            });
+    Object.entries(diff.simplified.renamedControlIds).forEach(([oldId, newId]) => {
+        renderableDiffData.hasRenamedControls = true;
+        renderableDiffData.renamedControls.push({
+            oldId: oldId,
+            newId: newId,
+        });
+    });
+    Object.entries(diff.originalDiff.changedControls).forEach(([id, controlDiff]) => {
+        var _a, _b;
+        if ((_a = controlDiff.descs) === null || _a === void 0 ? void 0 : _a.check) {
+            const oldCheck = lodash_1.default.get(controlDiff.descs.check, "__old");
+            const newCheck = lodash_1.default.get(controlDiff.descs.check, "__new");
+            if (oldCheck.replace(/\n/g, "").replace(/\W/g, "") !==
+                newCheck.replace(/\n/g, "").replace(/\W/g, "")) {
+                renderableDiffData.updatedChecks.push({
+                    id: id,
+                    old: oldCheck,
+                    new: newCheck,
+                });
+            }
+        }
+        if ((_b = controlDiff.descs) === null || _b === void 0 ? void 0 : _b.fix) {
+            const oldFix = lodash_1.default.get(controlDiff.descs.fix, "__old");
+            const newFix = lodash_1.default.get(controlDiff.descs.fix, "__new");
+            if (oldFix.replace(/\n/g, "").replace(/\W/g, "") !==
+                newFix.replace(/\n/g, "").replace(/\W/g, "")) {
+                renderableDiffData.updatedFixes.push({
+                    id: id,
+                    old: oldFix,
+                    new: newFix,
+                });
+            }
+        }
+        if (controlDiff.impact) {
+            const oldImpact = lodash_1.default.get(controlDiff.impact, "__old");
+            const newImpact = lodash_1.default.get(controlDiff.impact, "__new");
+            if (oldImpact !== newImpact) {
+                renderableDiffData.updatedImpacts.push({
+                    id: id,
+                    old: oldImpact,
+                    new: newImpact,
+                });
+            }
+        }
+        if (controlDiff.title) {
+            const oldTitle = lodash_1.default.get(controlDiff.title, "__old");
+            const newTitle = lodash_1.default.get(controlDiff.title, "__new");
+            if (oldTitle !== newTitle) {
+                renderableDiffData.updatedTitles.push({
+                    id: id,
+                    old: oldTitle,
+                    new: newTitle,
+                });
+            }
+        }
+        if (controlDiff.desc) {
+            const oldDesc = lodash_1.default.get(controlDiff.desc, "__old");
+            const newDesc = lodash_1.default.get(controlDiff.desc, "__new");
+            if (oldDesc !== newDesc) {
+                renderableDiffData.updatedDescriptions.push({
+                    id: id,
+                    old: oldDesc,
+                    new: newDesc,
+                });
+            }
         }
     });
     // Render output

package/lib/utilities/logging.d.ts

@@ -1,2 +1,2 @@
 import winston from "winston";
-export declare function createWinstonLogger(mapperName: string, level?: string): winston.Logger;
+export declare function createWinstonLogger(level?: string): winston.Logger;

package/lib/utilities/logging.js

@@ -3,13 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createWinstonLogger = void 0;
 const tslib_1 = require("tslib");
 const winston_1 = tslib_1.__importDefault(require("winston"));
-function createWinstonLogger(mapperName, level = 'debug') {
+function createWinstonLogger(level = 'debug') {
     return winston_1.default.createLogger({
         transports: [new winston_1.default.transports.Console()],
         level: level,
         format: winston_1.default.format.combine(winston_1.default.format.timestamp({
             format: 'MMM-DD-YYYY HH:mm:ss Z',
-        }), winston_1.default.format.printf(info => `[${[info.timestamp]}] ${mapperName} ${info.message}`)),
+        }), winston_1.default.format.printf(info => `[${[info.timestamp]}] ${info.message}`)),
     });
 }
 exports.createWinstonLogger = createWinstonLogger;

package/lib/utilities/update.d.ts

@@ -11,6 +11,7 @@ export declare type UpdatedProfileReturn = {
     };
     markdown: string;
 };
-export declare function updateControl(from: Control, update: Partial<Control>): Control;
-export declare function updateProfile(from: Profile, using: Profile): Omit<UpdatedProfileReturn, 'markdown'>;
+export declare function findUpdatedControlByAllIdentifiers(existingControl: Control, updatedControls: Control[]): Control | undefined;
+export declare function updateControl(from: Control, update: Partial<Control>, logger: winston.Logger): Control;
+export declare function updateProfile(from: Profile, using: Profile, logger: winston.Logger): Omit<UpdatedProfileReturn, 'markdown'>;
 export declare function updateProfileUsingXCCDF(from: Profile, using: string, id: 'group' | 'rule' | 'version', logger: winston.Logger, ovalDefinitions?: Record<string, OvalDefinitionValue>): UpdatedProfileReturn;

package/lib/utilities/update.js

@@ -2,13 +2,14 @@
 // Utilities to update a profile or control with new metadata
 // The ultimate goal is to preserve all the metadata that is already there and only add what is new
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateProfileUsingXCCDF = exports.updateProfile = exports.updateControl = void 0;
+exports.updateProfileUsingXCCDF = exports.updateProfile = exports.updateControl = exports.findUpdatedControlByAllIdentifiers = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const profile_1 = tslib_1.__importDefault(require("../objects/profile"));
 const xccdf_1 = require("../parsers/xccdf");
 const diff_1 = require("./diff");
 const diffMarkdown_1 = require("./diffMarkdown");
+const knownInSpecKeywords = ['title', 'desc', 'impact', 'ref', 'tag', "\""];
 function projectValuesOntoExistingObj(dst, src, currentPath = '') {
     for (const updatedValue in src) {
         const existingValue = lodash_1.default.get(dst, updatedValue);
@@ -31,40 +32,97 @@ function projectValuesOntoExistingObj(dst, src, currentPath = '') {
     }
     return dst;
 }
-function updateControl(from, update) {
-    return projectValuesOntoExistingObj(from, update);
+// This is the most likely thing to break if you are getting code formatting issues.
+// Extract the existing describe blocks (what is actually run by inspec for validation)
+function getExistingDescribeFromControl(control) {
+    if (control.code) {
+        let existingDescribeBlock = '';
+        let inQuoteBlock = false;
+        control.code.split('\n').forEach((line) => {
+            const wordSplit = line.trim().split(' ');
+            wordSplit.forEach((word, index) => {
+                const charSplit = word.split('');
+                charSplit.forEach((char, index) => {
+                    if (char === '"' && charSplit[index - 1] !== '\\') {
+                        inQuoteBlock = !inQuoteBlock;
+                    }
+                });
+            });
+            if (!inQuoteBlock) {
+                // Get the number of spaces at the beggining of the current line
+                const spaces = line.substring(0, line.indexOf(wordSplit[0])).length;
+                if (spaces >= 2) {
+                    const firstWord = wordSplit[0];
+                    if (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) === -1 || (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) !== -1 && spaces > 2)) {
+                        existingDescribeBlock += line + '\n';
+                    }
+                }
+            }
+        });
+        return existingDescribeBlock;
+    }
+    else {
+        return '';
+    }
+}
+function findUpdatedControlByAllIdentifiers(existingControl, updatedControls) {
+    // Try to match based on IDs
+    let updatedControl = updatedControls.find((updatedControl) => {
+        return updatedControl.id.toLowerCase() === existingControl.id.toLowerCase();
+    });
+    if (updatedControl) {
+        return updatedControl;
+    }
+    // Try to match based on legacy identifiers
+    updatedControl = updatedControls.find((updatedControl) => {
+        var _a;
+        return (_a = updatedControl.tags.legacy) === null || _a === void 0 ? void 0 : _a.some((legacyTag) => {
+            var _a;
+            return legacyTag.toLowerCase() === ((_a = existingControl.id) === null || _a === void 0 ? void 0 : _a.toLowerCase());
+        });
+    });
+    if (updatedControl) {
+        return updatedControl;
+    }
+    return undefined;
+}
+exports.findUpdatedControlByAllIdentifiers = findUpdatedControlByAllIdentifiers;
+function updateControl(from, update, logger) {
+    const existingDescribeBlock = getExistingDescribeFromControl(from);
+    logger.debug(`Existing describe block for control ${from.id}: ${JSON.stringify(existingDescribeBlock)}`);
+    const projectedControl = projectValuesOntoExistingObj(from, update);
+    projectedControl.describe = existingDescribeBlock;
+    return projectedControl;
 }
 exports.updateControl = updateControl;
-function updateProfile(from, using) {
+function updateProfile(from, using, logger) {
     // Update the profile with the new metadata
     const to = new profile_1.default(lodash_1.default.omit(from, 'controls'));
     // Find the diff
-    const diff = (0, diff_1.diffProfile)(from, using);
+    const diff = (0, diff_1.diffProfile)(from, using, logger);
     // Add the new controls
     diff.simplified.addedControlIDs.forEach(id => {
         const addedControl = diff.simplified.addedControls[id];
         if (addedControl) {
+            logger.debug(`New Control: ${addedControl.id} - ${addedControl.title}`);
             to.controls.push(addedControl);
         }
         else {
-            throw new Error("New control added but don't have the control data");
+            throw new Error(`New control ${id} added but don't have the control data`);
         }
     });
     // Update the existing controls
     for (const existingControl of from.controls) {
-        const updatedControl = using.controls.find(control => control.id === existingControl.id);
+        const updatedControl = findUpdatedControlByAllIdentifiers(existingControl, using.controls);
         if (updatedControl) {
-            const controlDiff = diff.simplified.changedControls[existingControl.id];
+            const controlDiff = diff.simplified.changedControls[updatedControl.id];
             if (controlDiff) {
-                to.controls.push(updateControl(existingControl, controlDiff));
+                to.controls.push(updateControl(existingControl, controlDiff, logger));
             }
             else {
                 to.controls.push(existingControl);
             }
         }
-        else {
-            console.log("Control not updated: " + existingControl.id);
-        }
     }
     return {
         profile: to,
@@ -73,7 +131,7 @@ function updateProfile(from, using) {
 }
 exports.updateProfile = updateProfile;
 function updateProfileUsingXCCDF(from, using, id, logger, ovalDefinitions) {
-    console.log(from.controls[0].desc);
+    logger.debug(`Updating profile ${from.name} with control IDs: ${id}`);
     // Parse the XCCDF benchmark and convert it into a Profile
     logger.debug('Loading XCCDF File');
     const xccdfProfile = (0, xccdf_1.processXCCDF)(using, false, id);
@@ -83,7 +141,7 @@ function updateProfileUsingXCCDF(from, using, id, logger, ovalDefinitions) {
     logger.debug('Loaded XCCDF File with newline replacements');
     // Update the profile and return
     logger.debug('Creating updated profile');
-    const updatedProfile = updateProfile(from, xccdfProfile);
+    const updatedProfile = updateProfile(from, xccdfProfile, logger);
     logger.debug('Creating diff markdown');
     // Create the markdown
     const markdown = (0, diffMarkdown_1.createDiffMarkdown)(updatedProfile.diff, xccdfProfileWithNLReplacement);

package/lib/utilities/xccdf.js

@@ -6,20 +6,6 @@ const fast_xml_parser_1 = tslib_1.__importDefault(require("fast-xml-parser"));
 const htmlparser = tslib_1.__importStar(require("htmlparser2"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const he_1 = tslib_1.__importDefault(require("he"));
-var htmlEntities = {
-    nbsp: ' ',
-    cent: '¢',
-    pound: '£',
-    yen: '¥',
-    euro: '€',
-    copy: '©',
-    reg: '®',
-    lt: '<',
-    gt: '>',
-    quot: '"',
-    amp: '&',
-    apos: '\''
-};
 function convertEncodedXmlIntoJson(encodedXml) {
     return fast_xml_parser_1.default.parse(encodedXml, {
         ignoreAttributes: false,

package/package-lock.json

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

package/package.json

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