@mitre/inspec-objects 0.0.10 → 0.0.13

package/lib/index.d.ts

@@ -3,3 +3,4 @@ export * from './objects/profile';
 export * from './parsers/json';
 export * from './parsers/xccdf';
 export * from './utilities/diff';
+export * from './utilities/update';

package/lib/index.js

@@ -6,3 +6,4 @@ tslib_1.__exportStar(require("./objects/profile"), exports);
 tslib_1.__exportStar(require("./parsers/json"), exports);
 tslib_1.__exportStar(require("./parsers/xccdf"), exports);
 tslib_1.__exportStar(require("./utilities/diff"), exports);
+tslib_1.__exportStar(require("./utilities/update"), exports);

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, removeNewlines: boolean | undefined, useRuleId: 'group' | 'rule' | 'version', ovalDefinitions?: Record<string, OvalDefinitionValue>): Profile;
+export declare function processXCCDF(xml: string, removeNewlines: boolean | undefined, useRuleId: 'group' | 'rule' | 'version' | 'cis', ovalDefinitions?: Record<string, OvalDefinitionValue>): Profile;

package/lib/parsers/xccdf.js

@@ -25,6 +25,9 @@ function extractAllRules(groups) {
     return rules;
 }
 exports.extractAllRules = extractAllRules;
+function ensureDecodedXMLStringValue(input) {
+    return lodash_1.default.get(input, '[0].#text') ? lodash_1.default.get(input, '[0].#text') : input;
+}
 function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
     const parsedXML = (0, xccdf_1.convertEncodedXmlIntoJson)(xml);
     const rules = extractAllRules(parsedXML.Benchmark[0].Group);
@@ -48,22 +51,31 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                 control.id = rule.group['@_id'];
                 break;
             case 'rule':
-                control.id = rule['@_id'].split('r')[0];
+                if (rule['@_id'].toLowerCase().startsWith('sv')) {
+                    control.id = rule['@_id'].split('r')[0];
+                }
+                else {
+                    control.id = rule['@_id'];
+                }
                 break;
             case 'version':
                 control.id = rule.version;
                 break;
+            case 'cis':
+                // 
+                control.id = 'CIS-PLACEHOLDER';
+                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}`);
+            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'] ? rule.title : `[[[MISSING SEVERITY FROM STIG]]] ${rule.title}`);
+            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']);
@@ -112,7 +124,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
         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.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'];
         control.tags.stig_id = rule['version'];
@@ -211,7 +223,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                             (_d = control.refs) === null || _d === void 0 ? void 0 : _d.push(lodash_1.default.get(reference, 'title'));
                         }
                     }
-                    // Add the reference to the control tags when seperated by §
+                    // Add the reference to the control tags when separated by §
                     if (typeof referenceText === 'string' && referenceText.indexOf('§') !== -1) {
                         const referenceParts = referenceText.split('§');
                         if (referenceParts.length == 2) {

package/lib/resources/automatticUpdateTemplate.json

@@ -0,0 +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}}"
+}