@infrascan/cli 0.4.0 → 0.5.0

package/dist/commands/graph.mjs

@@ -0,0 +1,64 @@
+// src/commands/graph.ts
+import { readFileSync, writeFileSync } from "fs";
+import { join, resolve } from "path";
+import {
+  CommandLineAction
+} from "@rushstack/ts-command-line";
+import buildFsConnector from "@infrascan/fs-connector";
+import {
+  serializeGraph
+} from "@infrascan/cytoscape-serializer";
+function readScanMetadata(outputPath) {
+  const scanMetadata = readFileSync(
+    join(resolve(outputPath), "metadata.json"),
+    "utf8"
+  );
+  return JSON.parse(scanMetadata);
+}
+function writeGraphOutput(outputPath, graphState) {
+  writeFileSync(
+    join(resolve(outputPath), "graph.json"),
+    JSON.stringify(graphState)
+  );
+}
+var GraphCmd = class extends CommandLineAction {
+  constructor(infrascanClient) {
+    super({
+      actionName: "graph",
+      summary: "Graphs a set of AWS accounts which have been scanned",
+      documentation: "Reads in the output of an account scan, and generates an infrastructure diagram from the output. The graph is saved to the local filesystem."
+    });
+    this.infrascanClient = infrascanClient;
+  }
+  onDefineParameters() {
+    this._outputDirectory = this.defineStringParameter({
+      parameterLongName: "--input",
+      parameterShortName: "-i",
+      argumentName: "PATH_TO_STATE",
+      description: "Location to read scan state from. This should be the same as the directory given to the scan command.",
+      defaultValue: "./state"
+    });
+  }
+  async onExecute() {
+    const scanMetadata = readScanMetadata(
+      this._outputDirectory.value
+    );
+    const connector = buildFsConnector(this._outputDirectory.value);
+    let nServicesScanned = 0;
+    this.infrascanClient.registerPlugin({
+      event: "onServiceComplete",
+      id: "countServicesScanner",
+      handler: () => {
+        nServicesScanned += 1;
+      }
+    });
+    const graphData = await this.infrascanClient.generateGraph(scanMetadata, connector, serializeGraph);
+    console.log(
+      `Graph Complete. Found resources in ${nServicesScanned} services.`
+    );
+    return writeGraphOutput(this._outputDirectory.value, graphData);
+  }
+};
+export {
+  GraphCmd as default
+};

package/dist/commands/render.mjs

@@ -0,0 +1,78 @@
+// src/commands/render.ts
+import { readFileSync, mkdtempSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { dirname, resolve, sep } from "node:path";
+import { fileURLToPath } from "node:url";
+import {
+  CommandLineAction
+} from "@rushstack/ts-command-line";
+import { renderFile } from "ejs";
+import open from "open";
+var RenderCmd = class extends CommandLineAction {
+  #graphPath;
+  #outputPath;
+  #launchBrowser;
+  constructor() {
+    super({
+      actionName: "render",
+      summary: "Renders your Infrascan graph in your browser",
+      documentation: "Loads in the output of a graph command, and render it in a static webpage.\n\nNote: this will only work with Cytoscape compatible graphs."
+    });
+  }
+  onDefineParameters() {
+    this.#graphPath = this.defineStringParameter({
+      parameterLongName: "--input",
+      parameterShortName: "-i",
+      argumentName: "PATH_TO_GRAPH",
+      description: "Location to read graph data from. This should be the path to the file output by the graph command.",
+      defaultValue: "./state/graph.json"
+    });
+    this.#outputPath = this.defineStringParameter({
+      parameterLongName: "--output",
+      parameterShortName: "-o",
+      argumentName: "OUTPUT_PATH_FOR_WEBPAGE",
+      description: "Location to save the generated graph page to. Defaults to a temp directory."
+    });
+    this.#launchBrowser = this.defineFlagParameter({
+      parameterLongName: "--browser",
+      description: "Launches the default browser to view the generated graph view."
+    });
+  }
+  async onExecute() {
+    const graphText = this.readGraphData();
+    if (graphText == null) {
+      process.exit(1);
+    }
+    const graph = JSON.parse(graphText);
+    const populatedGraphView = await renderFile(
+      resolve(
+        dirname(fileURLToPath(import.meta.url)),
+        "templates",
+        "index.html.ejs"
+      ),
+      {
+        graphData: JSON.stringify(graph)
+      }
+    );
+    let output = this.#outputPath.value != null ? this.#outputPath.value : mkdtempSync(`${tmpdir()}${sep}infrascan-generated-`);
+    if (!output.endsWith(".html")) {
+      output = `${output}${sep}index.html`;
+    }
+    writeFileSync(output, populatedGraphView);
+    console.log(`Graph view written to ${output}`);
+    if (this.#launchBrowser.value) {
+      await open(output, { wait: false });
+    }
+  }
+  readGraphData() {
+    try {
+      return readFileSync(this.#graphPath.value, "utf8");
+    } catch (err) {
+      console.error(`Failed to read graph data from: ${this.#graphPath.value}`);
+      return null;
+    }
+  }
+};
+export {
+  RenderCmd as default
+};

package/dist/commands/scan.mjs

@@ -0,0 +1,126 @@
+// src/commands/scan.ts
+import { writeFileSync } from "fs";
+import { resolve as resolve2, join } from "path";
+import {
+  CommandLineAction
+} from "@rushstack/ts-command-line";
+import buildFsConnector from "@infrascan/fs-connector";
+import {
+  fromIni,
+  fromNodeProviderChain,
+  fromTemporaryCredentials
+} from "@aws-sdk/credential-providers";
+import { loadSharedConfigFiles } from "@smithy/shared-ini-file-loader";
+
+// src/config.ts
+import { readFileSync } from "fs";
+import { resolve } from "path";
+import { env } from "process";
+import { DEFAULT_PROFILE } from "@smithy/shared-ini-file-loader";
+function getConfig(path) {
+  const resolvedConfigPath = resolve(path);
+  return JSON.parse(readFileSync(resolvedConfigPath, "utf8"));
+}
+function getDefaultRegion(parsedAwsConfig, currentProfile) {
+  const profile = currentProfile ?? env.AWS_PROFILE ?? DEFAULT_PROFILE;
+  return env.AWS_REGION ?? parsedAwsConfig?.[profile]?.region;
+}
+
+// src/commands/scan.ts
+function writeScanMetadata(outputDirectory, metadata) {
+  writeFileSync(
+    join(resolve2(outputDirectory), "metadata.json"),
+    JSON.stringify(metadata),
+    "utf8"
+  );
+}
+function resolveCredentialProvider(profile, roleToAssume) {
+  if (profile) {
+    return (region) => fromIni({
+      profile,
+      clientConfig: { region }
+    });
+  }
+  if (roleToAssume) {
+    return (region) => fromTemporaryCredentials({
+      params: {
+        RoleArn: roleToAssume,
+        RoleSessionName: "infrascan-cli-scan"
+      },
+      clientConfig: { region }
+    });
+  }
+  console.log(
+    "No profile or role given, falling back to default provider chain."
+  );
+  return (region) => fromNodeProviderChain({ clientConfig: { region } });
+}
+var ScanCmd = class extends CommandLineAction {
+  constructor(infrascanClient) {
+    super({
+      actionName: "scan",
+      summary: "Scans a set of AWS accounts",
+      documentation: "Reads in config of accounts, regions and services to scans, and executes a scan against each in turn. The ouput is saved to the local filesystem."
+    });
+    this.infrascanClient = infrascanClient;
+  }
+  onDefineParameters() {
+    this._config = this.defineStringParameter({
+      parameterLongName: "--config",
+      parameterShortName: "-c",
+      argumentName: "PATH_TO_CONFIG",
+      description: "Config to use for the scan."
+    });
+    this._outputDirectory = this.defineStringParameter({
+      parameterLongName: "--output",
+      parameterShortName: "-o",
+      argumentName: "PATH_TO_STATE_OUTPUT",
+      description: "Location to save scan output to.",
+      defaultValue: "./state"
+    });
+    this._regions = this.defineStringListParameter({
+      parameterLongName: "--region",
+      argumentName: "REGION_TO_SCAN",
+      description: "The region to scan. This flag can be provided many times e.g. --region us-east-1 --region eu-west-1"
+    });
+  }
+  async onExecute() {
+    const awsConfig = await loadSharedConfigFiles().catch((err) => {
+      console.warn(
+        `Failed to load AWS config file, falling back to @infrascan/sdk defaults. (${err.message})`
+      );
+      return void 0;
+    });
+    const defaultRegionFromEnv = getDefaultRegion(awsConfig?.configFile);
+    const runtimeRegionsToScan = this._regions.values.length > 0 ? this._regions.values : void 0;
+    const scanConfig = this._config.value ? getConfig(this._config.value) : [
+      {
+        defaultRegion: defaultRegionFromEnv
+      }
+    ];
+    const connector = buildFsConnector(this._outputDirectory.value, {
+      createTargetDirectory: true
+    });
+    const metadata = [];
+    for (const accountConfig of scanConfig) {
+      const {
+        profile,
+        roleToAssume,
+        regions,
+        defaultRegion: configDefaultRegion
+      } = accountConfig;
+      const credentials = resolveCredentialProvider(profile, roleToAssume);
+      const defaultRegion = configDefaultRegion ?? getDefaultRegion(awsConfig?.configFile, profile);
+      const accountMetadata = await this.infrascanClient.performScan(
+        credentials,
+        connector,
+        { regions: runtimeRegionsToScan ?? regions, defaultRegion }
+      );
+      metadata.push(accountMetadata);
+    }
+    return writeScanMetadata(this._outputDirectory.value, metadata);
+  }
+};
+export {
+  ScanCmd as default
+};

package/dist/config.mjs

@@ -0,0 +1,17 @@
+// src/config.ts
+import { readFileSync } from "fs";
+import { resolve } from "path";
+import { env } from "process";
+import { DEFAULT_PROFILE } from "@smithy/shared-ini-file-loader";
+function getConfig(path) {
+  const resolvedConfigPath = resolve(path);
+  return JSON.parse(readFileSync(resolvedConfigPath, "utf8"));
+}
+function getDefaultRegion(parsedAwsConfig, currentProfile) {
+  const profile = currentProfile ?? env.AWS_PROFILE ?? DEFAULT_PROFILE;
+  return env.AWS_REGION ?? parsedAwsConfig?.[profile]?.region;
+}
+export {
+  getConfig,
+  getDefaultRegion
+};

package/dist/index.mjs

@@ -12,7 +12,9 @@ import {
   CommandLineAction
 } from "@rushstack/ts-command-line";
 import buildFsConnector from "@infrascan/fs-connector";
-import { serializeGraph } from "@infrascan/cytoscape-serializer";
+import {
+  serializeGraph
+} from "@infrascan/cytoscape-serializer";
 function readScanMetadata(outputPath) {
   const scanMetadata = readFileSync(
     join(resolve(outputPath), "metadata.json"),
@@ -57,11 +59,7 @@ var GraphCmd = class extends CommandLineAction {
         nServicesScanned += 1;
       }
     });
-    const graphData = await this.infrascanClient.generateGraph(
-      scanMetadata,
-      connector,
-      serializeGraph
-    );
+    const graphData = await this.infrascanClient.generateGraph(scanMetadata, connector, serializeGraph);
     console.log(
       `Graph Complete. Found resources in ${nServicesScanned} services.`
     );
@@ -69,30 +67,104 @@ var GraphCmd = class extends CommandLineAction {
   }
 };
 
-// src/commands/scan.ts
-import { writeFileSync as writeFileSync2 } from "fs";
-import { resolve as resolve3, join as join2 } from "path";
+// src/commands/render.ts
+import { readFileSync as readFileSync2, mkdtempSync, writeFileSync as writeFileSync2 } from "node:fs";
+import { tmpdir } from "node:os";
+import { dirname, resolve as resolve2, sep } from "node:path";
+import { fileURLToPath } from "node:url";
 import {
   CommandLineAction as CommandLineAction2
 } from "@rushstack/ts-command-line";
+import { renderFile } from "ejs";
+import open from "open";
+var RenderCmd = class extends CommandLineAction2 {
+  #graphPath;
+  #outputPath;
+  #launchBrowser;
+  constructor() {
+    super({
+      actionName: "render",
+      summary: "Renders your Infrascan graph in your browser",
+      documentation: "Loads in the output of a graph command, and render it in a static webpage.\n\nNote: this will only work with Cytoscape compatible graphs."
+    });
+  }
+  onDefineParameters() {
+    this.#graphPath = this.defineStringParameter({
+      parameterLongName: "--input",
+      parameterShortName: "-i",
+      argumentName: "PATH_TO_GRAPH",
+      description: "Location to read graph data from. This should be the path to the file output by the graph command.",
+      defaultValue: "./state/graph.json"
+    });
+    this.#outputPath = this.defineStringParameter({
+      parameterLongName: "--output",
+      parameterShortName: "-o",
+      argumentName: "OUTPUT_PATH_FOR_WEBPAGE",
+      description: "Location to save the generated graph page to. Defaults to a temp directory."
+    });
+    this.#launchBrowser = this.defineFlagParameter({
+      parameterLongName: "--browser",
+      description: "Launches the default browser to view the generated graph view."
+    });
+  }
+  async onExecute() {
+    const graphText = this.readGraphData();
+    if (graphText == null) {
+      process.exit(1);
+    }
+    const graph = JSON.parse(graphText);
+    const populatedGraphView = await renderFile(
+      resolve2(
+        dirname(fileURLToPath(import.meta.url)),
+        "templates",
+        "index.html.ejs"
+      ),
+      {
+        graphData: JSON.stringify(graph)
+      }
+    );
+    let output = this.#outputPath.value != null ? this.#outputPath.value : mkdtempSync(`${tmpdir()}${sep}infrascan-generated-`);
+    if (!output.endsWith(".html")) {
+      output = `${output}${sep}index.html`;
+    }
+    writeFileSync2(output, populatedGraphView);
+    console.log(`Graph view written to ${output}`);
+    if (this.#launchBrowser.value) {
+      await open(output, { wait: false });
+    }
+  }
+  readGraphData() {
+    try {
+      return readFileSync2(this.#graphPath.value, "utf8");
+    } catch (err) {
+      console.error(`Failed to read graph data from: ${this.#graphPath.value}`);
+      return null;
+    }
+  }
+};
+
+// src/commands/scan.ts
+import { writeFileSync as writeFileSync3 } from "fs";
+import { resolve as resolve4, join as join2 } from "path";
+import {
+  CommandLineAction as CommandLineAction3
+} from "@rushstack/ts-command-line";
 import buildFsConnector2 from "@infrascan/fs-connector";
 import {
   fromIni,
   fromNodeProviderChain,
   fromTemporaryCredentials
 } from "@aws-sdk/credential-providers";
-import {
-  loadSharedConfigFiles
-} from "@smithy/shared-ini-file-loader";
+import { loadSharedConfigFiles } from "@smithy/shared-ini-file-loader";
 
 // src/config.ts
-import { readFileSync as readFileSync2 } from "fs";
-import { resolve as resolve2 } from "path";
+import { readFileSync as readFileSync3 } from "fs";
+import { resolve as resolve3 } from "path";
 import { env } from "process";
 import { DEFAULT_PROFILE } from "@smithy/shared-ini-file-loader";
 function getConfig(path) {
-  const resolvedConfigPath = resolve2(path);
-  return JSON.parse(readFileSync2(resolvedConfigPath, "utf8"));
+  const resolvedConfigPath = resolve3(path);
+  return JSON.parse(readFileSync3(resolvedConfigPath, "utf8"));
 }
 function getDefaultRegion(parsedAwsConfig, currentProfile) {
   const profile = currentProfile ?? env.AWS_PROFILE ?? DEFAULT_PROFILE;
@@ -101,8 +173,8 @@ function getDefaultRegion(parsedAwsConfig, currentProfile) {
 
 // src/commands/scan.ts
 function writeScanMetadata(outputDirectory, metadata) {
-  writeFileSync2(
-    join2(resolve3(outputDirectory), "metadata.json"),
+  writeFileSync3(
+    join2(resolve4(outputDirectory), "metadata.json"),
     JSON.stringify(metadata),
     "utf8"
   );
@@ -128,7 +200,7 @@ function resolveCredentialProvider(profile, roleToAssume) {
   );
   return (region) => fromNodeProviderChain({ clientConfig: { region } });
 }
-var ScanCmd = class extends CommandLineAction2 {
+var ScanCmd = class extends CommandLineAction3 {
   constructor(infrascanClient) {
     super({
       actionName: "scan",
@@ -203,8 +275,9 @@ var InfrascanCLI = class extends CommandLineParser {
       toolDescription: 'The "infrascan" tool helps you stay on top of your cloud infrastructure.'
     });
     const infrascanClient = registerAwsScanners(new Infrascan());
-    this.addAction(new ScanCmd(infrascanClient));
     this.addAction(new GraphCmd(infrascanClient));
+    this.addAction(new RenderCmd());
+    this.addAction(new ScanCmd(infrascanClient));
   }
   onExecute() {
     return super.onExecute();

package/dist/templates/index.html.ejs

@@ -0,0 +1,143 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <title>Infrascan Graph</title>
+ <link rel="icon" type="image/svg+xml" href="https://cdn.infrascan.io/img/logo.svg" />
+ <link 
+    rel="preload" 
+    as="fetch" 
+    type="application/json" 
+    href="https://cdn.infrascan.io/graph-styles/default.json" 
+    crossorigin 
+  />
+ <script 
+  src="https://cdnjs.cloudflare.com/ajax/libs/cytoscape/3.30.2/cytoscape.min.js" 
+  integrity="sha512-EY3U1MWdgKx0P1dqTE4inlKz2cpXtWpsR1YUyD855Hs6RL/A0cyvrKh60EpE8wDZ814cTe1KgRK+sG0Rn792vQ=="
+  crossorigin="anonymous"
+ ></script>
+ <style>
+  :root {
+    font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
+    line-height: 1.5;
+    font-weight: 400;
+
+    color-scheme: light dark;
+    color: rgba(255, 255, 255, 0.87);
+    background-color: #242424;
+
+    font-synthesis: none;
+    text-rendering: optimizeLegibility;
+    -webkit-font-smoothing: antialiased;
+    -moz-osx-font-smoothing: grayscale;
+    -webkit-text-size-adjust: 100%;
+  }
+
+  a {
+    font-weight: 500;
+    color: #646cff;
+    text-decoration: inherit;
+  }
+  a:hover {
+    color: #535bf2;
+  }
+
+  body {
+    margin: 0;
+    min-width: 100vw;
+    min-height: 100vh;
+  }
+
+  h1 {
+    font-size: 3.2em;
+    line-height: 1.1;
+  }
+
+  #app {
+    position: relative;
+    width: 100vw;
+    height: 100vh;
+    margin: 0 auto;
+  }
+
+  #graph-canvas {
+    width: 100vw;
+    height: 100vh;
+    background-image: radial-gradient(
+      circle at 20px 20px,
+      rgba(255, 255, 255, 0.3) 1px,
+      transparent 0px
+    );
+    background-size: 40px 40px;
+  }
+
+  #powered-by {
+    height: 32px;
+    width: 128px;
+    border-radius: 32px;
+
+    display: flex;
+    align-items: center;
+
+    background-color: #fff;
+    position: absolute;
+    top: calc(100vh - 64px);
+    left: calc(100vw - 192px);
+
+    cursor: pointer;
+  }
+  #powered-by > img {
+    padding-left: 8px;
+  }
+  #powered-by > div {
+    padding-left: 8px;
+  }
+  #powered-by > * > p {
+    font-size: 0.5rem;
+  }
+  #powered-by > * > p,
+  #powered-by > * > h5 {
+    margin: 0;
+    color: #000;
+  }
+ </style>
+ <script>
+  document.addEventListener('DOMContentLoaded', () => {
+
+   document.getElementById('powered-by')?.addEventListener("click", () => {
+     if (window != null) {
+       window?.open("https://infrascan.io", "_blank")?.focus();
+     }
+   });
+
+   const graphContent = <%- graphData %>;
+
+   if(window.cytoscape != null) {
+    fetch('https://cdn.infrascan.io/graph-styles/default.json')
+      .then((res) => res.json())
+      .then((graphStyle) => {
+        console.log(graphStyle);
+        window.graph = window.cytoscape({
+          container: document.getElementById("graph-canvas"),
+          elements: graphContent,
+          style: graphStyle,
+        });
+      });
+   }
+  });
+ </script>
+</head>
+<body>
+ <div id="app">
+  <div id="graph-canvas"></div>
+  <div id="powered-by">
+    <img src="https://cdn.infrascan.io/img/logo.svg" alt="Infrascan.io logo" />
+    <div>
+      <p>Powered By:</p>
+      <h5>Infrascan.io</h5>
+    </div>
+  </div>
+ </div>
+</body>
+</html>

package/package.json

@@ -1,24 +1,13 @@
 {
   "name": "@infrascan/cli",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Thin command line wrapper around the infrascan sdk",
   "main": "dist/index.mjs",
   "scripts": {
-    "build": "rm -rf dist ; tsup",
+    "build": "rm -rf dist ; tsup --config internal/tsconfig/app.tsup.json ; cp -r ./src/templates ./dist/templates",
     "lint": "tsc --noEmit ; eslint .",
     "clean": "rm -rf dist node_modules"
   },
-  "tsup": {
-    "clean": true,
-    "splitting": false,
-    "entry": [
-      "src/index.ts"
-    ],
-    "format": [
-      "esm"
-    ],
-    "target": "node18"
-  },
   "bin": {
     "infrascan": "./dist/index.mjs"
   },
@@ -36,20 +25,23 @@
   "author": "Liam Farrelly <liam@l3f7.dev> (https://whoisli.am/)",
   "license": "MPL-2.0",
   "dependencies": {
-    "@aws-sdk/credential-providers": "3.428.0",
+    "@aws-sdk/credential-providers": "3.624.0",
     "@infrascan/aws": "^0.4.1",
-    "@infrascan/cytoscape-serializer": "^0.2.0",
+    "@infrascan/cytoscape-serializer": "^0.2.1",
     "@infrascan/fs-connector": "^0.2.2",
-    "@infrascan/sdk": "^0.4.0",
+    "@infrascan/sdk": "^0.4.2",
     "@rushstack/ts-command-line": "^4.15.2",
     "@smithy/shared-ini-file-loader": "^2.2.2",
-    "minimatch": "^6.1.6"
+    "ejs": "^3.1.9",
+    "minimatch": "^6.1.6",
+    "open": "^10.1.0"
   },
   "devDependencies": {
-    "@aws-sdk/types": "3.428.0",
-    "@infrascan/shared-types": "^0.4.0",
+    "@aws-sdk/types": "3.609.0",
+    "@infrascan/shared-types": "^0.5.1",
     "@smithy/types": "^2.4.0",
+    "@types/ejs": "^3.1.5",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.3"
   }
-}
+}