kramscan 0.1.1 → 0.3.0

package/dist/commands/report.js

@@ -5,60 +5,59 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerReportCommand = registerReportCommand;
 const chalk_1 = __importDefault(require("chalk"));
-const logger_1 = require("../utils/logger");
-const config_1 = require("../core/config");
+const docx_1 = require("docx");
 const promises_1 = __importDefault(require("fs/promises"));
 const path_1 = __importDefault(require("path"));
-const os_1 = __importDefault(require("os"));
-const docx_1 = require("docx");
+const config_1 = require("../core/config");
+const scan_storage_1 = require("../core/scan-storage");
+const ai_client_1 = require("../core/ai-client");
+const logger_1 = require("../utils/logger");
 function registerReportCommand(program) {
     program
         .command("report [scan-file]")
         .description("Generate a professional security report")
         .option("-f, --format <type>", "Report format: word|json|txt")
         .option("-o, --output <file>", "Output filename")
+        .option("--ai-summary", "Generate an AI-powered executive summary")
         .action(async (scanFile, options) => {
         console.log("");
-        console.log(chalk_1.default.bold.cyan("📄 Generating Security Report"));
-        console.log(chalk_1.default.gray("─".repeat(50)));
+        console.log(chalk_1.default.bold.cyan("Generating Security Report"));
+        console.log(chalk_1.default.gray("-".repeat(50)));
         console.log("");
+        let spinner = null;
         try {
-            // Load scan results
-            let filepath;
-            if (scanFile) {
-                filepath = path_1.default.isAbsolute(scanFile)
-                    ? scanFile
-                    : path_1.default.join(process.cwd(), scanFile);
-            }
-            else {
-                // Find latest scan
-                const scanDir = path_1.default.join(os_1.default.homedir(), ".kramscan", "scans");
-                const files = await promises_1.default.readdir(scanDir);
-                const scanFiles = files.filter((f) => f.endsWith(".json"));
-                if (scanFiles.length === 0) {
-                    logger_1.logger.error("No scan results found. Run 'kramscan scan <url>' first.");
-                    process.exit(1);
-                }
-                scanFiles.sort().reverse();
-                filepath = path_1.default.join(scanDir, scanFiles[0]);
-                logger_1.logger.info(`Using latest scan: ${scanFiles[0]}`);
+            const resolved = await (0, scan_storage_1.resolveScanFile)(scanFile);
+            const filepath = resolved.filepath;
+            if (resolved.isLatest) {
+                logger_1.logger.info(`Using latest scan: ${resolved.filename}`);
             }
             const content = await promises_1.default.readFile(filepath, "utf-8");
             const scanResult = JSON.parse(content);
-            // Determine format
             const config = await (0, config_1.getConfig)();
-            const format = options.format || config.report.defaultFormat;
-            const spinner = logger_1.logger.spinner(`Generating ${format.toUpperCase()} report...`);
+            const format = (options.format || config.report.defaultFormat);
+            let aiSummary;
+            if (options.aiSummary) {
+                spinner = logger_1.logger.spinner("Generating AI executive summary...");
+                try {
+                    const aiClient = await (0, ai_client_1.createAIClient)();
+                    aiSummary = await (0, ai_client_1.generateExecutiveSummary)(aiClient, scanResult);
+                    spinner.succeed("AI summary generated!");
+                }
+                catch (err) {
+                    spinner.warn(`AI summary failed: ${err.message}`);
+                }
+            }
+            spinner = logger_1.logger.spinner(`Generating ${format.toUpperCase()} report...`);
             let outputPath;
             switch (format) {
                 case "word":
-                    outputPath = await generateWordReport(scanResult, options.output);
+                    outputPath = await generateWordReport(scanResult, options.output, aiSummary);
                     break;
                 case "json":
-                    outputPath = await generateJsonReport(scanResult, options.output);
+                    outputPath = await generateJsonReport(scanResult, options.output, aiSummary);
                     break;
                 case "txt":
-                    outputPath = await generateTxtReport(scanResult, options.output);
+                    outputPath = await generateTxtReport(scanResult, options.output, aiSummary);
                     break;
                 default:
                     throw new Error(`Unsupported format: ${format}`);
@@ -69,18 +68,20 @@ function registerReportCommand(program) {
             console.log("");
         }
         catch (error) {
+            if (spinner) {
+                spinner.fail("Report generation failed");
+            }
             logger_1.logger.error(error.message);
             process.exit(1);
         }
     });
 }
-async function generateWordReport(scanResult, outputFile) {
+async function generateWordReport(scanResult, outputFile, aiSummary) {
     const doc = new docx_1.Document({
         sections: [
             {
                 properties: {},
                 children: [
-                    // Title
                     new docx_1.Paragraph({
                         text: "Security Assessment Report",
                         heading: docx_1.HeadingLevel.HEADING_1,
@@ -95,7 +96,6 @@ async function generateWordReport(scanResult, outputFile) {
                         alignment: docx_1.AlignmentType.CENTER,
                     }),
                     new docx_1.Paragraph({ text: "" }),
-                    // Executive Summary
                     new docx_1.Paragraph({
                         text: "Executive Summary",
                         heading: docx_1.HeadingLevel.HEADING_2,
@@ -103,45 +103,37 @@ async function generateWordReport(scanResult, outputFile) {
                     new docx_1.Paragraph({
                         children: [
                             new docx_1.TextRun({
-                                text: `This report contains the results of an automated security assessment performed on ${scanResult.target}. `,
-                            }),
-                            new docx_1.TextRun({
-                                text: `A total of ${scanResult.summary.total} vulnerabilities were identified, `,
-                            }),
-                            new docx_1.TextRun({
-                                text: `including ${scanResult.summary.critical} critical and ${scanResult.summary.high} high severity issues.`,
+                                text: aiSummary || `This report contains the results of an automated security assessment performed on ${scanResult.target}. ` +
+                                    `A total of ${scanResult.summary.total} vulnerabilities were identified, ` +
+                                    `including ${scanResult.summary.critical} critical and ${scanResult.summary.high} high severity issues.`,
                             }),
                         ],
                     }),
                     new docx_1.Paragraph({ text: "" }),
-                    // Scan Statistics
                     new docx_1.Paragraph({
                         text: "Scan Statistics",
                         heading: docx_1.HeadingLevel.HEADING_2,
                     }),
-                    new docx_1.Paragraph({ text: `• URLs Crawled: ${scanResult.metadata.crawledUrls}` }),
-                    new docx_1.Paragraph({ text: `• Forms Tested: ${scanResult.metadata.testedForms}` }),
-                    new docx_1.Paragraph({ text: `• Requests Made: ${scanResult.metadata.requestsMade}` }),
+                    new docx_1.Paragraph({ text: `- URLs Crawled: ${scanResult.metadata.crawledUrls}` }),
+                    new docx_1.Paragraph({ text: `- Forms Tested: ${scanResult.metadata.testedForms}` }),
+                    new docx_1.Paragraph({ text: `- Requests Made: ${scanResult.metadata.requestsMade}` }),
                     new docx_1.Paragraph({
-                        text: `• Duration: ${(scanResult.duration / 1000).toFixed(2)} seconds`,
+                        text: `- Duration: ${(scanResult.duration / 1000).toFixed(2)} seconds`,
                     }),
                     new docx_1.Paragraph({ text: "" }),
-                    // Findings
                     new docx_1.Paragraph({
                         text: "Detailed Findings",
                         heading: docx_1.HeadingLevel.HEADING_2,
                     }),
-                    ...scanResult.vulnerabilities.flatMap((vuln, i) => [
+                    ...scanResult.vulnerabilities.flatMap((vuln, index) => [
                         new docx_1.Paragraph({
-                            text: `${i + 1}. ${vuln.title} [${vuln.severity.toUpperCase()}]`,
+                            text: `${index + 1}. ${vuln.title} [${vuln.severity.toUpperCase()}]`,
                             heading: docx_1.HeadingLevel.HEADING_3,
                         }),
                         new docx_1.Paragraph({ text: `URL: ${vuln.url}` }),
                         new docx_1.Paragraph({ text: `Type: ${vuln.type}` }),
                         new docx_1.Paragraph({ text: `Description: ${vuln.description}` }),
-                        ...(vuln.evidence
-                            ? [new docx_1.Paragraph({ text: `Evidence: ${vuln.evidence}` })]
-                            : []),
+                        ...(vuln.evidence ? [new docx_1.Paragraph({ text: `Evidence: ${vuln.evidence}` })] : []),
                         ...(vuln.remediation
                             ? [new docx_1.Paragraph({ text: `Remediation: ${vuln.remediation}` })]
                             : []),
@@ -153,28 +145,23 @@ async function generateWordReport(scanResult, outputFile) {
         ],
     });
     const buffer = await docx_1.Packer.toBuffer(doc);
-    const reportsDir = path_1.default.join(os_1.default.homedir(), ".kramscan", "reports");
-    await promises_1.default.mkdir(reportsDir, { recursive: true });
+    const reportsDir = await (0, scan_storage_1.ensureReportsDirectory)();
     const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
     const filename = outputFile || `report-${timestamp}.docx`;
-    const filepath = path_1.default.isAbsolute(filename)
-        ? filename
-        : path_1.default.join(reportsDir, filename);
+    const filepath = path_1.default.isAbsolute(filename) ? filename : path_1.default.join(reportsDir, filename);
     await promises_1.default.writeFile(filepath, buffer);
     return filepath;
 }
-async function generateJsonReport(scanResult, outputFile) {
-    const reportsDir = path_1.default.join(os_1.default.homedir(), ".kramscan", "reports");
-    await promises_1.default.mkdir(reportsDir, { recursive: true });
+async function generateJsonReport(scanResult, outputFile, aiSummary) {
+    const reportsDir = await (0, scan_storage_1.ensureReportsDirectory)();
     const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
     const filename = outputFile || `report-${timestamp}.json`;
-    const filepath = path_1.default.isAbsolute(filename)
-        ? filename
-        : path_1.default.join(reportsDir, filename);
-    await promises_1.default.writeFile(filepath, JSON.stringify(scanResult, null, 2));
+    const filepath = path_1.default.isAbsolute(filename) ? filename : path_1.default.join(reportsDir, filename);
+    const finalResult = aiSummary ? { ...scanResult, aiSummary } : scanResult;
+    await promises_1.default.writeFile(filepath, JSON.stringify(finalResult, null, 2));
     return filepath;
 }
-async function generateTxtReport(scanResult, outputFile) {
+async function generateTxtReport(scanResult, outputFile, aiSummary) {
     const lines = [];
     lines.push("=".repeat(60));
     lines.push("SECURITY ASSESSMENT REPORT");
@@ -186,7 +173,12 @@ async function generateTxtReport(scanResult, outputFile) {
     lines.push("");
     lines.push("EXECUTIVE SUMMARY");
     lines.push("-".repeat(60));
-    lines.push(`Total Vulnerabilities: ${scanResult.summary.total} (${scanResult.summary.critical} Critical, ${scanResult.summary.high} High, ${scanResult.summary.medium} Medium, ${scanResult.summary.low} Low, ${scanResult.summary.info} Info)`);
+    if (aiSummary) {
+        lines.push(aiSummary);
+    }
+    else {
+        lines.push(`Total Vulnerabilities: ${scanResult.summary.total} (${scanResult.summary.critical} Critical, ${scanResult.summary.high} High, ${scanResult.summary.medium} Medium, ${scanResult.summary.low} Low, ${scanResult.summary.info} Info)`);
+    }
     lines.push("");
     lines.push("SCAN STATISTICS");
     lines.push("-".repeat(60));
@@ -197,29 +189,29 @@ async function generateTxtReport(scanResult, outputFile) {
     lines.push("DETAILED FINDINGS");
     lines.push("-".repeat(60));
     lines.push("");
-    scanResult.vulnerabilities.forEach((vuln, i) => {
-        lines.push(`${i + 1}. ${vuln.title} [${vuln.severity.toUpperCase()}]`);
+    scanResult.vulnerabilities.forEach((vuln, index) => {
+        lines.push(`${index + 1}. ${vuln.title} [${vuln.severity.toUpperCase()}]`);
         lines.push(`   URL: ${vuln.url}`);
         lines.push(`   Type: ${vuln.type}`);
         lines.push(`   Description: ${vuln.description}`);
-        if (vuln.evidence)
+        if (vuln.evidence) {
             lines.push(`   Evidence: ${vuln.evidence}`);
-        if (vuln.remediation)
+        }
+        if (vuln.remediation) {
             lines.push(`   Remediation: ${vuln.remediation}`);
-        if (vuln.cwe)
+        }
+        if (vuln.cwe) {
             lines.push(`   CWE: ${vuln.cwe}`);
+        }
         lines.push("");
     });
     lines.push("=".repeat(60));
     lines.push("End of Report");
     lines.push("=".repeat(60));
-    const reportsDir = path_1.default.join(os_1.default.homedir(), ".kramscan", "reports");
-    await promises_1.default.mkdir(reportsDir, { recursive: true });
+    const reportsDir = await (0, scan_storage_1.ensureReportsDirectory)();
     const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
     const filename = outputFile || `report-${timestamp}.txt`;
-    const filepath = path_1.default.isAbsolute(filename)
-        ? filename
-        : path_1.default.join(reportsDir, filename);
+    const filepath = path_1.default.isAbsolute(filename) ? filename : path_1.default.join(reportsDir, filename);
     await promises_1.default.writeFile(filepath, lines.join("\n"));
     return filepath;
 }