@mitre/inspec-objects 0.0.13 → 0.0.14

package/lib/objects/control.d.ts

@@ -8,6 +8,7 @@ export default class Control {
     id?: string | null;
     title?: string | null;
     code?: string | null;
+    describe?: string | null;
     desc?: string | null;
     descs?: {
         [key: string]: string | undefined;

package/lib/objects/control.js

@@ -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}`);
@@ -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/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,15 @@ 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');
             }
             else if (rule.check.some((ruleValue) => 'check-content-ref' in ruleValue) && ovalDefinitions) {
                 let referenceID = null;
@@ -104,26 +90,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 +115,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;
@@ -194,7 +168,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                 }
             });
         }
-        (_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/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.js

@@ -9,6 +9,7 @@ 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,8 +32,44 @@ function projectValuesOntoExistingObj(dst, src, currentPath = '') {
     }
     return dst;
 }
+// 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 updateControl(from, update) {
-    return projectValuesOntoExistingObj(from, update);
+    const existingDescribeBlock = getExistingDescribeFromControl(from);
+    const projectedControl = projectValuesOntoExistingObj(from, update);
+    projectedControl.describe = existingDescribeBlock;
+    return projectedControl;
 }
 exports.updateControl = updateControl;
 function updateProfile(from, using) {
@@ -73,7 +110,6 @@ function updateProfile(from, using) {
 }
 exports.updateProfile = updateProfile;
 function updateProfileUsingXCCDF(from, using, id, logger, ovalDefinitions) {
-    console.log(from.controls[0].desc);
     // Parse the XCCDF benchmark and convert it into a Profile
     logger.debug('Loading XCCDF File');
     const xccdfProfile = (0, xccdf_1.processXCCDF)(using, false, id);

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@mitre/inspec-objects",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@mitre/inspec-objects",
-      "version": "0.0.13",
+      "version": "0.0.14",
       "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.14",
   "description": "Typescript objects for normalizing between InSpec profiles and XCCDF benchmarks",
   "main": "lib/index.js",
   "publishConfig": {