@mitre/inspec-objects 0.0.2 → 0.0.5

package/lib/objects/control.js

@@ -28,13 +28,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 +42,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 +58,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 +84,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/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, 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

@@ -6,7 +6,7 @@ const profile_1 = tslib_1.__importDefault(require("../objects/profile"));
 const xccdf_1 = require("../utilities/xccdf");
 const control_1 = tslib_1.__importDefault(require("../objects/control"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const hdf_converters_1 = require("@mitre/hdf-converters");
+const CciNistMappingData_1 = require("../mappings/CciNistMappingData");
 function extractAllRules(groups) {
     const rules = [];
     groups.forEach((group) => {
@@ -25,7 +25,7 @@ function extractAllRules(groups) {
     return rules;
 }
 exports.extractAllRules = extractAllRules;
-function processXCCDF(xml, 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({
@@ -34,7 +34,7 @@ function processXCCDF(xml, ovalDefinitions) {
         summary: parsedXML.Benchmark[0].description[0]['#text']
     });
     rules.forEach(rule => {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         let extractedDescription;
         if (Array.isArray(rule.description)) {
             extractedDescription = rule.description[0]['#text'];
@@ -43,16 +43,43 @@ function processXCCDF(xml, ovalDefinitions) {
             extractedDescription = (0, xccdf_1.convertEncodedHTMLIntoJson)(rule.description);
         }
         const control = new control_1.default();
-        control.id = rule.group['@_id'];
-        control.title = rule['@_severity'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${rule.title}`;
-        control.desc = typeof extractedDescription === 'string' ? extractedDescription : (_a = extractedDescription.VulnDiscussion) === null || _a === void 0 ? void 0 : _a.split('Satisfies: ')[0];
+        control.id = rule['@_id'];
+        switch (useRuleId) {
+            case 'group':
+                control.id = rule.group['@_id'];
+                break;
+            case 'rule':
+                control.id = rule['@_id'];
+                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}}}}');
+            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.replace(/\n/g, '{{{{newlineHERE}}}}');
+        }
+        else {
+            control.title = (0, xccdf_1.removeXMLSpecialCharacters)(rule['@_severity'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${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']);
         if (!control.descs || Array.isArray(control.descs)) {
             control.descs = {};
         }
         if (rule.check) {
             if (rule.check.some((ruleValue) => 'check-content' in ruleValue)) {
-                control.descs.check = rule.check ? rule.check[0]['check-content'] : 'Missing description';
+                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');
+                }
             }
             else if (rule.check.some((ruleValue) => 'check-content-ref' in ruleValue) && ovalDefinitions) {
                 let referenceID = null;
@@ -66,23 +93,35 @@ function processXCCDF(xml, ovalDefinitions) {
                     }
                 }
                 if (referenceID && referenceID in ovalDefinitions) {
-                    control.descs.check = ovalDefinitions[referenceID].metadata[0].title;
+                    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);
+                    }
                 }
                 else if (referenceID) {
                     console.warn(`Could not find OVAL definition for ${referenceID}`);
                 }
             }
         }
-        control.descs.fix = rule.fixtext ? rule.fixtext[0]['#text'] : (rule.fix ? rule.fix[0]['#text'] || 'Missing fix text' : 'Missing fix text');
+        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.tags.severity = (0, xccdf_1.impactNumberToSeverityString)((0, xccdf_1.severityStringToImpact)(rule['@_severity'] || 'critical', control.id));
         control.tags.gid = rule.group['@_id'],
             control.tags.rid = rule['@_id'];
         control.tags.stig_id = rule['version'];
         if (typeof rule.group.title === "string") {
-            control.tags.gtitle = rule.group.title;
+            control.tags.gtitle = (0, xccdf_1.removeXMLSpecialCharacters)(rule.group.title);
         }
         else {
-            control.tags.gtitle = lodash_1.default.get(rule.group, 'title[0].#text');
+            control.tags.gtitle = (0, xccdf_1.removeXMLSpecialCharacters)(lodash_1.default.get(rule.group, 'title[0].#text'));
         }
         if (rule['fix'] && rule['fix'].length > 0) {
             control.tags.fix_id = rule['fix'][0]['@_id'];
@@ -97,7 +136,7 @@ function processXCCDF(xml, ovalDefinitions) {
             control.tags.rationale = null;
         }
         if (typeof extractedDescription === 'object') {
-            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.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;
             control.tags.false_positives = extractedDescription.FalsePositives || undefined;
             control.tags.documentable = typeof extractedDescription.Documentable === 'boolean' ? extractedDescription.Documentable : undefined;
@@ -110,7 +149,14 @@ function processXCCDF(xml, ovalDefinitions) {
             control.tags.responsibility = extractedDescription.Responsibility || undefined;
             control.tags.ia_controls = extractedDescription.IAControls || undefined;
         }
-        control.tags = lodash_1.default.omitBy(control.tags, (value) => value === undefined);
+        control.tags = lodash_1.default.mapValues(lodash_1.default.omitBy(control.tags, (value) => value === undefined), (value) => {
+            if (typeof value === 'string') {
+                return (0, xccdf_1.removeXMLSpecialCharacters)(value);
+            }
+            else {
+                return value;
+            }
+        });
         // Get all identifiers from the rule
         if (rule.ident) {
             rule.ident.forEach((identifier) => {
@@ -143,7 +189,7 @@ function processXCCDF(xml, ovalDefinitions) {
                 }
             });
         }
-        (_c = rule.reference) === null || _c === void 0 ? void 0 : _c.forEach((reference) => {
+        (_d = rule.reference) === null || _d === void 0 ? void 0 : _d.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'));
@@ -208,8 +254,8 @@ function processXCCDF(xml, ovalDefinitions) {
                 if (!('nist' in control.tags)) {
                     control.tags.nist = [];
                 }
-                if (cci in hdf_converters_1.CciNistMappingData.data) {
-                    (_a = control.tags.nist) === null || _a === void 0 ? void 0 : _a.push(lodash_1.default.get(hdf_converters_1.CciNistMappingData.data, cci));
+                if (cci in CciNistMappingData_1.data) {
+                    (_a = control.tags.nist) === null || _a === void 0 ? void 0 : _a.push(lodash_1.default.get(CciNistMappingData_1.data, cci));
                 }
             });
         }