@mitre/hdf-converters 2.13.0 → 3.0.0

package/lib/src/converters-from-hdf/caat/reverse-caat-mapper.js

@@ -1,227 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FromHDFToCAATMapper = exports.CAATHeaders = void 0;
-const XLSX = __importStar(require("@e965/xlsx"));
-const inspecjs_1 = require("inspecjs");
-const _ = __importStar(require("lodash"));
-const global_1 = require("../../utils/global");
-exports.CAATHeaders = [
-    'Control Number',
-    'Finding Title',
-    'Date Identified',
-    'Finding ID',
-    'Information System or Program Name',
-    'Repeat Findings',
-    'Repeat Finding Weakness ID',
-    'Finding Description',
-    'Weakness Description',
-    'Control Weakness Type',
-    'Source',
-    'Assessment/Audit Company',
-    'Test Method',
-    'Test Objective',
-    'Test Result Description',
-    'Test Result',
-    'Recommended Corrective Action(s)',
-    'Effect on Business',
-    'Likelihood',
-    'Impact'
-];
-class FromHDFToCAATMapper {
-    static MaxCellSize = 32000;
-    static MaxSheetNameLength = 31;
-    static NistCanonizationConfig = {
-        max_specifiers: 3,
-        pad_zeros: true,
-        allow_letters: false,
-        add_spaces: false
-    };
-    static FileSettings = {
-        Title: 'Compliance Assessment/Audit Tracking (CAAT) Spreadsheet',
-        Subject: 'Assessment Data',
-        Author: 'MITRE SAF',
-        CreatedDate: new Date()
-    };
-    static SheetOptions = {
-        header: exports.CAATHeaders.slice() // CAATHeaders is immutable but the type expects a mutable string
-    };
-    static formatDate(date, delimiter) {
-        return [
-            Intl.DateTimeFormat('en-US', { month: '2-digit' }),
-            Intl.DateTimeFormat('en-US', { day: '2-digit' }),
-            Intl.DateTimeFormat('en-US', { year: 'numeric' })
-        ]
-            .map((formatter) => formatter.format(date))
-            .join(delimiter);
-    }
-    // ensure we're using Windows style newlines and fit within the maximum length
-    static fix(str) {
-        return (str ?? '')
-            .replace(/(\r\n|\n|\r)/gmu, '\r\n')
-            .slice(0, FromHDFToCAATMapper.MaxCellSize);
-    }
-    data;
-    // ensure input is turned into an array of contextualized evaluations with some additional metadata
-    constructor(data) {
-        if (!Array.isArray(data)) {
-            data = [data];
-        }
-        this.data = data.map((datum) => {
-            let contextualizedEvaluation = datum.data;
-            if (_.isString(contextualizedEvaluation)) {
-                const contextualizedFile = (0, inspecjs_1.convertFileContextual)(contextualizedEvaluation);
-                if (!(0, inspecjs_1.isContextualizedEvaluation)(contextualizedFile)) {
-                    throw new Error('Input string was not an HDF ExecJSON');
-                }
-                contextualizedEvaluation = contextualizedFile;
-            }
-            contextualizedEvaluation = (0, global_1.ensureContextualizedEvaluation)(contextualizedEvaluation);
-            return {
-                data: contextualizedEvaluation,
-                filename: datum.filename ?? // if provided a filename use it
-                    contextualizedEvaluation.data.profiles.at(0)?.name ?? // otherwise use the name of the first profile which is typically the only profile or the wrapper or overlay profile if there are multiple
-                    'ExecJSON', // otherwise set the default
-                controls: datum.controls
-            };
-        });
-    }
-    newCaveat(hdf) {
-        const caveat = hdf.descriptions.caveat
-            ? `(Caveat: ${FromHDFToCAATMapper.fix(hdf.descriptions.caveat)})\r\n`
-            : '';
-        return `${caveat}${FromHDFToCAATMapper.fix(hdf.wraps.desc)}`;
-    }
-    newTestResultDescription(hdf) {
-        const controlStatus = `${hdf.status}:\r\n\r\n`;
-        const description = hdf.segments
-            ?.map((result) => {
-            const statusAndTest = `${result.status.toUpperCase()} -- Test: ${result.code_desc}\r\n`;
-            const message = result.message
-                ? `Message: ${result.message}\r\n\r\n`
-                : '\r\n';
-            return `${statusAndTest}${message}`;
-        })
-            .join('') ?? '';
-        return `${controlStatus}${description}`;
-    }
-    newTestResult(hdf) {
-        return hdf.status === 'Passed' ? 'Satisfied' : 'Other Than Satisfied';
-    }
-    newImpact(hdf) {
-        const controlSeverity = hdf.severity === 'medium' ? 'moderate' : hdf.severity;
-        return FromHDFToCAATMapper.fix(hdf.wraps.impact === 0 ? 'none' : controlSeverity);
-    }
-    getRow(control, filename) {
-        const hdf = control.hdf;
-        const allRows = _.compact(hdf
-            .canonized_nist(FromHDFToCAATMapper.NistCanonizationConfig)
-            .map((formattedNistTag) => {
-            // I have not found a sample that triggers this case because the canonized_nist function seems to only return a nist tag
-            if (!formattedNistTag) {
-                // early exiting forces us to use the compact function to get rid of empty values in the array
-                return;
-            }
-            const row = {};
-            row['Control Number'] = formattedNistTag;
-            row['Finding Title'] = `Test ${FromHDFToCAATMapper.fix(hdf.wraps.id)} - ${FromHDFToCAATMapper.fix(hdf.wraps.title)}`;
-            if (hdf.start_time) {
-                row['Date Identified'] = FromHDFToCAATMapper.formatDate(new Date(hdf.start_time), '/');
-            }
-            row['Finding ID'] = `${filename} - Test ${FromHDFToCAATMapper.fix(hdf.wraps.id)}`;
-            row['Finding Description'] = FromHDFToCAATMapper.fix(hdf.wraps.title);
-            row['Weakness Description'] = this.newCaveat(hdf);
-            row['Control Weakness Type'] = 'Security';
-            row['Source'] = 'Self-Assessment';
-            row['Test Method'] = 'Test';
-            row['Test Objective'] = FromHDFToCAATMapper.fix(hdf.descriptions.check ?? hdf.wraps.tags.check);
-            row['Test Result Description'] = FromHDFToCAATMapper.fix(this.newTestResultDescription(hdf));
-            row['Test Result'] = this.newTestResult(hdf);
-            row['Recommended Corrective Action(s)'] = FromHDFToCAATMapper.fix(hdf.descriptions.fix ?? hdf.wraps.tags.fix);
-            row['Impact'] = this.newImpact(hdf);
-            return row;
-        }));
-        return allRows;
-    }
-    // returnWorkBook: true -> raw workbook class
-    // returnWorkBook: false | undefined -> binary string by default otherwise whatever is specified in the options parameter
-    toCAAT(returnWorkBook = false, options = { bookType: 'xlsx', type: 'binary' }) {
-        // Sheet names must be unique across the workbook
-        const takenSheetNames = [];
-        // Define our workbook
-        const workBook = XLSX.utils.book_new();
-        // For each contextualized evaluation
-        for (const d of this.data) {
-            // Ensure sheet name uniqueness
-            let renameCount = 2;
-            const fullName = `${d.filename ?? d.data.data.profiles.at(0)?.name ?? 'ExecJSON'}`;
-            let sheetName = fullName.substring(0, FromHDFToCAATMapper.MaxSheetNameLength);
-            while (takenSheetNames.includes(sheetName)) {
-                sheetName =
-                    fullName.substring(0, FromHDFToCAATMapper.MaxSheetNameLength - 5) +
-                        ` (${renameCount})`; // space for up to a 2 digit number; there's no check to stop it going past other than the workbook failing to be created, but that should be fine since the likelihood of someone having that many dupes is very slim
-                renameCount++;
-            }
-            takenSheetNames.push(sheetName);
-            // Create a new Sheet
-            workBook.SheetNames.push(sheetName);
-            workBook.Props = FromHDFToCAATMapper.FileSettings;
-            // Get the controls for the current evaluation
-            const processedControls = new Set();
-            const rows = [];
-            // Convert them into rows
-            for (const control of d.controls ??
-                d.data.contains.flatMap((profile) => profile.contains)) {
-                const root = control.root;
-                // Overlay profiles will usually share controls
-                if (processedControls.has(root.hdf.wraps.id)) {
-                    continue;
-                }
-                processedControls.add(root.hdf.wraps.id);
-                rows.push(...this.getRow(root, d.filename));
-            }
-            rows.sort((x, y) => x['Finding Title']?.localeCompare(y['Finding Title'] ?? '') ?? 1);
-            // Add rows to sheet
-            const workSheet = XLSX.utils.json_to_sheet(rows, FromHDFToCAATMapper.SheetOptions);
-            workBook.Sheets[sheetName] = workSheet;
-        }
-        if (returnWorkBook) {
-            return workBook;
-        }
-        return XLSX.write(workBook, options);
-    }
-}
-exports.FromHDFToCAATMapper = FromHDFToCAATMapper;
-//# sourceMappingURL=reverse-caat-mapper.js.map

package/lib/src/converters-from-hdf/caat/reverse-caat-mapper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"reverse-caat-mapper.js","sourceRoot":"","sources":["../../../../src/converters-from-hdf/caat/reverse-caat-mapper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AACnC,uCAQkB;AAClB,0CAA4B;AAC5B,+CAAkE;AAUrD,QAAA,WAAW,GAAG;IACzB,gBAAgB;IAChB,eAAe;IACf,iBAAiB;IACjB,YAAY;IACZ,oCAAoC;IACpC,iBAAiB;IACjB,4BAA4B;IAC5B,qBAAqB;IACrB,sBAAsB;IACtB,uBAAuB;IACvB,QAAQ;IACR,0BAA0B;IAC1B,aAAa;IACb,gBAAgB;IAChB,yBAAyB;IACzB,aAAa;IACb,kCAAkC;IAClC,oBAAoB;IACpB,YAAY;IACZ,QAAQ;CACA,CAAC;AAMX,MAAa,mBAAmB;IAC9B,MAAM,CAAU,WAAW,GAAG,KAAK,CAAC;IACpC,MAAM,CAAU,kBAAkB,GAAG,EAAE,CAAC;IAExC,MAAM,CAAU,sBAAsB,GAAuB;QAC3D,cAAc,EAAE,CAAC;QACjB,SAAS,EAAE,IAAI;QACf,aAAa,EAAE,KAAK;QACpB,UAAU,EAAE,KAAK;KAClB,CAAC;IAEF,MAAM,CAAU,YAAY,GAAoB;QAC9C,KAAK,EAAE,yDAAyD;QAChE,OAAO,EAAE,iBAAiB;QAC1B,MAAM,EAAE,WAAW;QACnB,WAAW,EAAE,IAAI,IAAI,EAAE;KACxB,CAAC;IAEF,MAAM,CAAU,YAAY,GAAwB;QAClD,MAAM,EAAE,mBAAW,CAAC,KAAK,EAAE,CAAC,iEAAiE;KAC9F,CAAC;IAEF,MAAM,CAAC,UAAU,CAAC,IAAU,EAAE,SAAiB;QAC7C,OAAO;YACL,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAC,KAAK,EAAE,SAAS,EAAC,CAAC;YAChD,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAC,GAAG,EAAE,SAAS,EAAC,CAAC;YAC9C,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAC,IAAI,EAAE,SAAS,EAAC,CAAC;SAChD;aACE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aAC1C,IAAI,CAAC,SAAS,CAAC,CAAC;IACrB,CAAC;IAED,8EAA8E;IAC9E,MAAM,CAAC,GAAG,CAAC,GAAmB;QAC5B,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;aACf,OAAO,CAAC,iBAAiB,EAAE,MAAM,CAAC;aAClC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,CAAS;IAEb,mGAAmG;IACnG,YAAY,IAA6B;QACvC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,IAAI,wBAAwB,GAAG,KAAK,CAAC,IAAI,CAAC;YAC1C,IAAI,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,CAAC;gBACzC,MAAM,kBAAkB,GAAG,IAAA,gCAAqB,EAC9C,wBAAwB,CACzB,CAAC;gBACF,IAAI,CAAC,IAAA,qCAA0B,EAAC,kBAAkB,CAAC,EAAE,CAAC;oBACpD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;gBAC1D,CAAC;gBACD,wBAAwB,GAAG,kBAAkB,CAAC;YAChD,CAAC;YACD,wBAAwB,GAAG,IAAA,uCAA8B,EACvD,wBAAwB,CACzB,CAAC;YACF,OAAO;gBACL,IAAI,EAAE,wBAAwB;gBAC9B,QAAQ,EACN,KAAK,CAAC,QAAQ,IAAI,gCAAgC;oBAClD,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,0IAA0I;oBAChM,UAAU,EAAE,4BAA4B;gBAC1C,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS,CAAC,GAAe;QACvB,MAAM,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM;YACpC,CAAC,CAAC,YAAY,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO;YACrE,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,GAAG,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;IAC/D,CAAC;IAED,wBAAwB,CAAC,GAAe;QACtC,MAAM,aAAa,GAAG,GAAG,GAAG,CAAC,MAAM,WAAW,CAAC;QAC/C,MAAM,WAAW,GACf,GAAG,CAAC,QAAQ;YACV,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,MAAM,aAAa,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,aAClD,MAAM,CAAC,SACT,MAAM,CAAC;YACP,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO;gBAC5B,CAAC,CAAC,YAAY,MAAM,CAAC,OAAO,UAAU;gBACtC,CAAC,CAAC,MAAM,CAAC;YACX,OAAO,GAAG,aAAa,GAAG,OAAO,EAAE,CAAC;QACtC,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;QACpB,OAAO,GAAG,aAAa,GAAG,WAAW,EAAE,CAAC;IAC1C,CAAC;IAED,aAAa,CAAC,GAAe;QAC3B,OAAO,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,sBAAsB,CAAC;IACxE,CAAC;IAED,SAAS,CAAC,GAAe;QACvB,MAAM,eAAe,GACnB,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;QACxD,OAAO,mBAAmB,CAAC,GAAG,CAC5B,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,CAClD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,OAA8B,EAAE,QAAgB;QACrD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACxB,MAAM,OAAO,GAAc,CAAC,CAAC,OAAO,CAClC,GAAG;aACA,cAAc,CAAC,mBAAmB,CAAC,sBAAsB,CAAC;aAC1D,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE;YACxB,wHAAwH;YACxH,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,8FAA8F;gBAC9F,OAAO;YACT,CAAC;YAED,MAAM,GAAG,GAAY,EAAE,CAAC;YACxB,GAAG,CAAC,gBAAgB,CAAC,GAAG,gBAAgB,CAAC;YACzC,GAAG,CAAC,eAAe,CAAC,GAAG,QAAQ,mBAAmB,CAAC,GAAG,CACpD,GAAG,CAAC,KAAK,CAAC,EAAE,CACb,MAAM,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAClD,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;gBACnB,GAAG,CAAC,iBAAiB,CAAC,GAAG,mBAAmB,CAAC,UAAU,CACrD,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EACxB,GAAG,CACJ,CAAC;YACJ,CAAC;YACD,GAAG,CAAC,YAAY,CAAC,GAAG,GAAG,QAAQ,WAAW,mBAAmB,CAAC,GAAG,CAC/D,GAAG,CAAC,KAAK,CAAC,EAAE,CACb,EAAE,CAAC;YACJ,GAAG,CAAC,qBAAqB,CAAC,GAAG,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACtE,GAAG,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAClD,GAAG,CAAC,uBAAuB,CAAC,GAAG,UAAU,CAAC;YAC1C,GAAG,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC;YAClC,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;YAC5B,GAAG,CAAC,gBAAgB,CAAC,GAAG,mBAAmB,CAAC,GAAG,CAC7C,GAAG,CAAC,YAAY,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAC/C,CAAC;YACF,GAAG,CAAC,yBAAyB,CAAC,GAAG,mBAAmB,CAAC,GAAG,CACtD,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CACnC,CAAC;YACF,GAAG,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAC7C,GAAG,CAAC,kCAAkC,CAAC,GAAG,mBAAmB,CAAC,GAAG,CAC/D,GAAG,CAAC,YAAY,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAC3C,CAAC;YACF,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CACL,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,6CAA6C;IAC7C,yHAAyH;IACzH,MAAM,CACJ,cAAc,GAAG,KAAK,EACtB,UAA+B,EAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAC;QAEjE,iDAAiD;QACjD,MAAM,eAAe,GAAa,EAAE,CAAC;QAErC,sBAAsB;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAEvC,qCAAqC;QACrC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC1B,+BAA+B;YAC/B,IAAI,WAAW,GAAG,CAAC,CAAC;YACpB,MAAM,QAAQ,GAAG,GACf,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,UACpD,EAAE,CAAC;YACH,IAAI,SAAS,GAAW,QAAQ,CAAC,SAAS,CACxC,CAAC,EACD,mBAAmB,CAAC,kBAAkB,CACvC,CAAC;YACF,OAAO,eAAe,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3C,SAAS;oBACP,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,mBAAmB,CAAC,kBAAkB,GAAG,CAAC,CAAC;wBACjE,KAAK,WAAW,GAAG,CAAC,CAAC,sNAAsN;gBAC7O,WAAW,EAAE,CAAC;YAChB,CAAC;YACD,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAEhC,qBAAqB;YACrB,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACpC,QAAQ,CAAC,KAAK,GAAG,mBAAmB,CAAC,YAAY,CAAC;YAElD,8CAA8C;YAC9C,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAE,CAAC;YACpC,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,yBAAyB;YACzB,KAAK,MAAM,OAAO,IAAI,CAAC,CAAC,QAAQ;gBAC9B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACzD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;gBAE1B,+CAA+C;gBAC/C,IAAI,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC7C,SAAS;gBACX,CAAC;gBAED,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACzC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9C,CAAC;YAED,IAAI,CAAC,IAAI,CACP,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,CAAC,CAAC,eAAe,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CACnE,CAAC;YAEF,oBAAoB;YACpB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CACxC,IAAI,EACJ,mBAAmB,CAAC,YAAY,CACjC,CAAC;YACF,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;QACzC,CAAC;QAED,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;;AAhOH,kDAiOC","sourcesContent":["import * as XLSX from '@e965/xlsx';\nimport {\n  CanonizationConfig,\n  ContextualizedControl,\n  ContextualizedEvaluation,\n  convertFileContextual,\n  ExecJSON,\n  HDFControl,\n  isContextualizedEvaluation\n} from 'inspecjs';\nimport * as _ from 'lodash';\nimport {ensureContextualizedEvaluation} from '../../utils/global';\n\nexport type InputData = {\n  data: string | ExecJSON.Execution | ContextualizedEvaluation;\n  filename?: string;\n  controls?: ContextualizedControl[];\n};\n\ntype Data = InputData & {data: ContextualizedEvaluation; filename: string};\n\nexport const CAATHeaders = [\n  'Control Number',\n  'Finding Title',\n  'Date Identified',\n  'Finding ID',\n  'Information System or Program Name',\n  'Repeat Findings',\n  'Repeat Finding Weakness ID',\n  'Finding Description',\n  'Weakness Description',\n  'Control Weakness Type',\n  'Source',\n  'Assessment/Audit Company',\n  'Test Method',\n  'Test Objective',\n  'Test Result Description',\n  'Test Result',\n  'Recommended Corrective Action(s)',\n  'Effect on Business',\n  'Likelihood',\n  'Impact'\n] as const;\n\nexport type CAATRow = Partial<\n  Record<(typeof CAATHeaders)[number], string | undefined>\n>;\n\nexport class FromHDFToCAATMapper {\n  static readonly MaxCellSize = 32000;\n  static readonly MaxSheetNameLength = 31;\n\n  static readonly NistCanonizationConfig: CanonizationConfig = {\n    max_specifiers: 3,\n    pad_zeros: true,\n    allow_letters: false,\n    add_spaces: false\n  };\n\n  static readonly FileSettings: XLSX.Properties = {\n    Title: 'Compliance Assessment/Audit Tracking (CAAT) Spreadsheet',\n    Subject: 'Assessment Data',\n    Author: 'MITRE SAF',\n    CreatedDate: new Date()\n  };\n\n  static readonly SheetOptions: XLSX.JSON2SheetOpts = {\n    header: CAATHeaders.slice() // CAATHeaders is immutable but the type expects a mutable string\n  };\n\n  static formatDate(date: Date, delimiter: string): string {\n    return [\n      Intl.DateTimeFormat('en-US', {month: '2-digit'}),\n      Intl.DateTimeFormat('en-US', {day: '2-digit'}),\n      Intl.DateTimeFormat('en-US', {year: 'numeric'})\n    ]\n      .map((formatter) => formatter.format(date))\n      .join(delimiter);\n  }\n\n  // ensure we're using Windows style newlines and fit within the maximum length\n  static fix(str?: string | null): string {\n    return (str ?? '')\n      .replace(/(\\r\\n|\\n|\\r)/gmu, '\\r\\n')\n      .slice(0, FromHDFToCAATMapper.MaxCellSize);\n  }\n\n  data: Data[];\n\n  // ensure input is turned into an array of contextualized evaluations with some additional metadata\n  constructor(data: InputData | InputData[]) {\n    if (!Array.isArray(data)) {\n      data = [data];\n    }\n    this.data = data.map((datum) => {\n      let contextualizedEvaluation = datum.data;\n      if (_.isString(contextualizedEvaluation)) {\n        const contextualizedFile = convertFileContextual(\n          contextualizedEvaluation\n        );\n        if (!isContextualizedEvaluation(contextualizedFile)) {\n          throw new Error('Input string was not an HDF ExecJSON');\n        }\n        contextualizedEvaluation = contextualizedFile;\n      }\n      contextualizedEvaluation = ensureContextualizedEvaluation(\n        contextualizedEvaluation\n      );\n      return {\n        data: contextualizedEvaluation,\n        filename:\n          datum.filename ?? // if provided a filename use it\n          contextualizedEvaluation.data.profiles.at(0)?.name ?? // otherwise use the name of the first profile which is typically the only profile or the wrapper or overlay profile if there are multiple\n          'ExecJSON', // otherwise set the default\n        controls: datum.controls\n      };\n    });\n  }\n\n  newCaveat(hdf: HDFControl): string {\n    const caveat = hdf.descriptions.caveat\n      ? `(Caveat: ${FromHDFToCAATMapper.fix(hdf.descriptions.caveat)})\\r\\n`\n      : '';\n    return `${caveat}${FromHDFToCAATMapper.fix(hdf.wraps.desc)}`;\n  }\n\n  newTestResultDescription(hdf: HDFControl): string {\n    const controlStatus = `${hdf.status}:\\r\\n\\r\\n`;\n    const description =\n      hdf.segments\n        ?.map((result) => {\n          const statusAndTest = `${result.status.toUpperCase()} -- Test: ${\n            result.code_desc\n          }\\r\\n`;\n          const message = result.message\n            ? `Message: ${result.message}\\r\\n\\r\\n`\n            : '\\r\\n';\n          return `${statusAndTest}${message}`;\n        })\n        .join('') ?? '';\n    return `${controlStatus}${description}`;\n  }\n\n  newTestResult(hdf: HDFControl): string {\n    return hdf.status === 'Passed' ? 'Satisfied' : 'Other Than Satisfied';\n  }\n\n  newImpact(hdf: HDFControl): string {\n    const controlSeverity =\n      hdf.severity === 'medium' ? 'moderate' : hdf.severity;\n    return FromHDFToCAATMapper.fix(\n      hdf.wraps.impact === 0 ? 'none' : controlSeverity\n    );\n  }\n\n  getRow(control: ContextualizedControl, filename: string): CAATRow[] {\n    const hdf = control.hdf;\n    const allRows: CAATRow[] = _.compact(\n      hdf\n        .canonized_nist(FromHDFToCAATMapper.NistCanonizationConfig)\n        .map((formattedNistTag) => {\n          // I have not found a sample that triggers this case because the canonized_nist function seems to only return a nist tag\n          if (!formattedNistTag) {\n            // early exiting forces us to use the compact function to get rid of empty values in the array\n            return;\n          }\n\n          const row: CAATRow = {};\n          row['Control Number'] = formattedNistTag;\n          row['Finding Title'] = `Test ${FromHDFToCAATMapper.fix(\n            hdf.wraps.id\n          )} - ${FromHDFToCAATMapper.fix(hdf.wraps.title)}`;\n          if (hdf.start_time) {\n            row['Date Identified'] = FromHDFToCAATMapper.formatDate(\n              new Date(hdf.start_time),\n              '/'\n            );\n          }\n          row['Finding ID'] = `${filename} - Test ${FromHDFToCAATMapper.fix(\n            hdf.wraps.id\n          )}`;\n          row['Finding Description'] = FromHDFToCAATMapper.fix(hdf.wraps.title);\n          row['Weakness Description'] = this.newCaveat(hdf);\n          row['Control Weakness Type'] = 'Security';\n          row['Source'] = 'Self-Assessment';\n          row['Test Method'] = 'Test';\n          row['Test Objective'] = FromHDFToCAATMapper.fix(\n            hdf.descriptions.check ?? hdf.wraps.tags.check\n          );\n          row['Test Result Description'] = FromHDFToCAATMapper.fix(\n            this.newTestResultDescription(hdf)\n          );\n          row['Test Result'] = this.newTestResult(hdf);\n          row['Recommended Corrective Action(s)'] = FromHDFToCAATMapper.fix(\n            hdf.descriptions.fix ?? hdf.wraps.tags.fix\n          );\n          row['Impact'] = this.newImpact(hdf);\n          return row;\n        })\n    );\n    return allRows;\n  }\n\n  // returnWorkBook: true -> raw workbook class\n  // returnWorkBook: false | undefined -> binary string by default otherwise whatever is specified in the options parameter\n  toCAAT(\n    returnWorkBook = false,\n    options: XLSX.WritingOptions = {bookType: 'xlsx', type: 'binary'}\n  ) {\n    // Sheet names must be unique across the workbook\n    const takenSheetNames: string[] = [];\n\n    // Define our workbook\n    const workBook = XLSX.utils.book_new();\n\n    // For each contextualized evaluation\n    for (const d of this.data) {\n      // Ensure sheet name uniqueness\n      let renameCount = 2;\n      const fullName = `${\n        d.filename ?? d.data.data.profiles.at(0)?.name ?? 'ExecJSON'\n      }`;\n      let sheetName: string = fullName.substring(\n        0,\n        FromHDFToCAATMapper.MaxSheetNameLength\n      );\n      while (takenSheetNames.includes(sheetName)) {\n        sheetName =\n          fullName.substring(0, FromHDFToCAATMapper.MaxSheetNameLength - 5) +\n          ` (${renameCount})`; // space for up to a 2 digit number; there's no check to stop it going past other than the workbook failing to be created, but that should be fine since the likelihood of someone having that many dupes is very slim\n        renameCount++;\n      }\n      takenSheetNames.push(sheetName);\n\n      // Create a new Sheet\n      workBook.SheetNames.push(sheetName);\n      workBook.Props = FromHDFToCAATMapper.FileSettings;\n\n      // Get the controls for the current evaluation\n      const processedControls = new Set();\n      const rows: CAATRow[] = [];\n      // Convert them into rows\n      for (const control of d.controls ??\n        d.data.contains.flatMap((profile) => profile.contains)) {\n        const root = control.root;\n\n        // Overlay profiles will usually share controls\n        if (processedControls.has(root.hdf.wraps.id)) {\n          continue;\n        }\n\n        processedControls.add(root.hdf.wraps.id);\n        rows.push(...this.getRow(root, d.filename));\n      }\n\n      rows.sort(\n        (x, y) =>\n          x['Finding Title']?.localeCompare(y['Finding Title'] ?? '') ?? 1\n      );\n\n      // Add rows to sheet\n      const workSheet = XLSX.utils.json_to_sheet(\n        rows,\n        FromHDFToCAATMapper.SheetOptions\n      );\n      workBook.Sheets[sheetName] = workSheet;\n    }\n\n    if (returnWorkBook) {\n      return workBook;\n    }\n    return XLSX.write(workBook, options);\n  }\n}\n"]}