@mitre/inspec-objects 0.0.24 → 0.0.27

package/lib/utilities/update.d.ts

@@ -1,4 +1,4 @@
-import winston from 'winston';
+import winston from "winston";
 import Control from '../objects/control';
 import Profile from '../objects/profile';
 import { ProfileDiff } from '../types/diff';

package/lib/utilities/update.js

@@ -9,15 +9,13 @@ 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', '"'];
+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);
         // We have a new value for something that already exists in dst
         if (existingValue !== undefined) {
-            if (typeof existingValue === 'object' &&
-                existingValue !== null &&
-                !Array.isArray(existingValue)) {
+            if (typeof existingValue === 'object' && existingValue !== null && !Array.isArray(existingValue)) {
                 dst[updatedValue] = projectValuesOntoExistingObj(existingValue, src[updatedValue], currentPath + updatedValue + '.');
             }
             else if (typeof src[updatedValue] === 'string') {
@@ -27,9 +25,7 @@ function projectValuesOntoExistingObj(dst, src, currentPath = '') {
                 lodash_1.default.set(dst, updatedValue, src[updatedValue]);
             }
             else if (Array.isArray(src[updatedValue])) {
-                const uniqueArrayValues = [
-                    ...new Set(lodash_1.default.get(dst, updatedValue, []).concat(src[updatedValue]))
-                ];
+                const uniqueArrayValues = [...new Set(lodash_1.default.get(dst, updatedValue, []).concat(src[updatedValue]))];
                 lodash_1.default.set(dst, updatedValue, uniqueArrayValues);
             }
         }
@@ -44,24 +40,23 @@ function getExistingDescribeFromControl(control) {
         let currentQuoteEscape = '';
         let inQuoteBlock = false;
         let inMetadataValueOverride = false;
-        const splitLines = control.code.split('\n');
-        splitLines.forEach((line, lineIndex) => {
-            // Special case - Multi-line arrayed metadata value
-            if (typeof splitLines[lineIndex - 1] === 'string') {
-                if (knownInSpecKeywords.indexOf(splitLines[lineIndex - 1].trim().split(' ')[0]) !== -1 &&
-                    splitLines[lineIndex - 1].trim().split(' ')[1].startsWith('[')) {
-                    inMetadataValueOverride = true;
-                }
-            }
+        let indentedMetadataOverride = false;
+        let mostSpacesSeen = 0;
+        control.code.split('\n').forEach((line) => {
             const wordSplit = line.trim().split(' ');
-            if (!inQuoteBlock && !inMetadataValueOverride) {
+            const spaces = line.substring(0, line.indexOf(wordSplit[0])).length;
+            if (spaces - mostSpacesSeen > 10) {
+                indentedMetadataOverride = true;
+            }
+            else {
+                mostSpacesSeen = spaces;
+                indentedMetadataOverride = false;
+            }
+            if (!inQuoteBlock && !inMetadataValueOverride && !indentedMetadataOverride) {
                 // 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)) {
+                    if (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) === -1 || (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) !== -1 && spaces > 2)) {
                         existingDescribeBlock += line + '\n';
                     }
                 }
@@ -70,7 +65,7 @@ function getExistingDescribeFromControl(control) {
                 const charSplit = word.split('');
                 charSplit.forEach((char, index) => {
                     if (char === '"' && charSplit[index - 1] !== '\\') {
-                        if (!currentQuoteEscape) {
+                        if (!currentQuoteEscape || !inQuoteBlock) {
                             currentQuoteEscape = '"';
                         }
                         if (currentQuoteEscape === '"') {
@@ -78,7 +73,7 @@ function getExistingDescribeFromControl(control) {
                         }
                     }
                     else if (char === "'" && charSplit[index - 1] !== '\\') {
-                        if (!currentQuoteEscape) {
+                        if (!currentQuoteEscape || !inQuoteBlock) {
                             currentQuoteEscape = "'";
                         }
                         if (currentQuoteEscape === "'") {
@@ -87,6 +82,10 @@ function getExistingDescribeFromControl(control) {
                     }
                 });
             });
+            if (control.id === 'SV-204392') {
+                console.log(line);
+                console.log(inQuoteBlock);
+            }
         });
         return existingDescribeBlock;
     }
@@ -130,7 +129,7 @@ function updateProfile(from, using, logger) {
     // Find the diff
     const diff = (0, diff_1.diffProfile)(from, using, logger);
     // Add the new controls
-    diff.simplified.addedControlIDs.forEach((id) => {
+    diff.simplified.addedControlIDs.forEach(id => {
         const addedControl = diff.simplified.addedControls[id];
         if (addedControl) {
             logger.debug(`New Control: ${addedControl.id} - ${addedControl.title}`);
@@ -155,7 +154,7 @@ function updateProfile(from, using, logger) {
     }
     return {
         profile: to,
-        diff
+        diff,
     };
 }
 exports.updateProfile = updateProfile;

package/lib/utilities/xccdf.d.ts

@@ -1,5 +1,6 @@
 import { DecodedDescription } from '../types/xccdf';
 export declare function convertEncodedXmlIntoJson(encodedXml: string): any;
+export declare function convertJsonIntoXML(data: any): string;
 export declare function removeXMLSpecialCharacters(str: string): string;
 export declare function severityStringToImpact(string: string, id: string): number;
 export declare function impactNumberToSeverityString(impact: number): string;

package/lib/utilities/xccdf.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertEncodedHTMLIntoJson = exports.impactNumberToSeverityString = exports.severityStringToImpact = exports.removeXMLSpecialCharacters = exports.convertEncodedXmlIntoJson = void 0;
+exports.convertEncodedHTMLIntoJson = exports.impactNumberToSeverityString = exports.severityStringToImpact = exports.removeXMLSpecialCharacters = exports.convertJsonIntoXML = exports.convertEncodedXmlIntoJson = void 0;
 const tslib_1 = require("tslib");
 const fast_xml_parser_1 = tslib_1.__importDefault(require("fast-xml-parser"));
+const jstoxml_1 = require("jstoxml");
 const htmlparser = tslib_1.__importStar(require("htmlparser2"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const he_1 = tslib_1.__importDefault(require("he"));
@@ -11,10 +12,15 @@ function convertEncodedXmlIntoJson(encodedXml) {
         ignoreAttributes: false,
         ignoreNameSpace: true,
         attributeNamePrefix: '@_',
+        stopNodes: ['div', 'p'],
         arrayMode: true
     });
 }
 exports.convertEncodedXmlIntoJson = convertEncodedXmlIntoJson;
+function convertJsonIntoXML(data) {
+    return (0, jstoxml_1.toXML)(data);
+}
+exports.convertJsonIntoXML = convertJsonIntoXML;
 function removeXMLSpecialCharacters(str) {
     return he_1.default.decode(str);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mitre/inspec-objects",
-  "version": "0.0.24",
+  "version": "0.0.27",
   "description": "Typescript objects for normalizing between InSpec profiles and XCCDF benchmarks",
   "main": "lib/index.js",
   "publishConfig": {
@@ -25,8 +25,10 @@
     "@types/flat": "^5.0.2",
     "@types/he": "^1.1.2",
     "@types/json-diff": "^0.7.0",
+    "@types/jstoxml": "^2.0.2",
     "@types/lodash": "^4.14.178",
     "@types/mustache": "^4.2.0",
+    "@types/pretty": "^2.0.1",
     "fast-xml-parser": "^3.1.19",
     "flat": "^5.0.2",
     "he": "^1.2.0",
@@ -34,8 +36,10 @@
     "inspecjs": "^2.6.6",
     "jest": "^28.1.1",
     "json-diff": "^0.9.0",
+    "jstoxml": "^3.2.3",
     "lodash": "^4.17.21",
     "mustache": "^4.2.0",
+    "pretty": "^2.0.0",
     "ts-jest": "^28.0.4",
     "typescript": "^4.5.5",
     "winston": "^3.8.1",