@contrast/agent 4.27.2 → 4.28.0

package/config-diagnostics.js

@@ -20,11 +20,11 @@ const path = require('path');
 
 const HELP_MESSAGE = `
 Description:
-  The read-contrast-config utility returns the current effective node agent configuration.
+  The config-diagnostics utility returns the current effective node agent configuration.
 
 Usage:
-  npx -p @contrast/agent read-contrast-config <path/to/entry/script> [options]
-  npx -p @contrast/agent read-contrast-config --help
+  npx -p @contrast/agent config-diagnostics <path/to/entry/script> [options]
+  npx -p @contrast/agent config-diagnostics --help
 
 Options:
   --quiet      -q     Prevents output of the report to the console.

package/lib/contrast.js

@@ -26,6 +26,7 @@ const sourceMapUtility = require('./util/source-map');
 const loggerFactory = require('./core/logger');
 const logger = loggerFactory('contrast:contrast-init');
 const { outputAgentConfigFile } = require('./util/config-diagnostics-utils');
+const { fetchSystemInfo, outputSystemInfo } = require('../system-diagnostics');
 
 function getAgentSnippet() {
   // getting reference to name every time for testing purposes
@@ -335,6 +336,9 @@ contrastAgent.bootstrap = function(args) {
       } catch (err) {
         outputAgentConfigFile(agent, options, args, err);
       }
+
+      const info = fetchSystemInfo();
+      outputSystemInfo({ skip: false, quiet: true, output: 'contrast_system_info.json' }, info);
     });
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agent",
-  "version": "4.27.2",
+  "version": "4.28.0",
   "description": "Node.js security instrumentation by Contrast Security",
   "keywords": [
     "security",
@@ -55,7 +55,8 @@
     "node-contrast": "cli.js",
     "perf-logs": "perf-logs.js",
     "contrast-transpile": "cli-rewriter.js",
-    "read-contrast-config": "config-diagnostics.js"
+    "config-diagnostics": "config-diagnostics.js",
+    "system-diagnostics": "system-diagnostics.js"
   },
   "files": [
     "bin/**",
@@ -66,7 +67,8 @@
     "esm.mjs",
     "perf-logs.js",
     "cli-rewriter.js",
-    "config-diagnostics.js"
+    "config-diagnostics.js",
+    "system-diagnostics.js"
   ],
   "repository": {
     "type": "git"

package/system-diagnostics.js

@@ -0,0 +1,171 @@
+#!/usr/bin/env node
+/**
+Copyright: 2022 Contrast Security, Inc
+  Contact: support@contrastsecurity.com
+  License: Commercial
+
+  NOTICE: This Software and the patented inventions embodied within may only be
+  used as part of Contrast Security’s commercial offerings. Even though it is
+  made available through public repositories, use of this Software is subject to
+  the applicable End User Licensing Agreement found at
+  https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+  between Contrast Security and the End User. The Software may not be reverse
+  engineered, modified, repackaged, sold, redistributed or otherwise used in a
+  way not consistent with the End User License Agreement.
+*/
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+const pkg = require('./package');
+const { setup } = require('./lib/core/config/util');
+const logger = require('./lib/core/logger')('contrast:system-diagnostics');
+
+const HELP_MESSAGE = `
+Description:
+  The system-diagnostics utility returns the system info for the server/container the agent is running on.
+
+Usage:
+  npx -p @contrast/agent system-diagnostics --help
+  npx -p @contrast/agent system-diagnostics [options]
+
+Options:
+  --quiet      -q     Prevents output of the report to the console.
+  --output     -o     The directory to write the report in. Defaults to the current directory.
+`;
+
+function isContainer() {
+  try {
+    fs.statSync('/.dockerenv');
+    return true;
+  } catch (err) {
+    // if no docker env, check /proc/self/cgroup
+  }
+
+  try {
+    return fs.readFileSync('/proc/self/cgroup', 'utf8').includes('docker');
+  } catch (err) {
+    return false;
+  }
+}
+
+function isUsingPM2() {
+  const externalPkgPath =
+    process.env['npm_package_json'] || path.join(process.env['PWD'], 'package.json');
+  const externalPkg = require(externalPkgPath);
+  return { used: (process.env.pmx || false), version: externalPkg.dependencies.pm2 };
+}
+
+const diagnostics = {
+  parseArgv(argv) {
+    const args = {
+      help: false,
+      output: 'contrast_system_info.json',
+      quiet: false,
+    };
+
+    for (let i = 0; i < argv.length; i++) {
+      const arg = argv[i];
+
+      switch (arg) {
+        case '--help':
+          args.help = true;
+          return args;
+        case '--output':
+        case '-o': {
+          // grab the next value and skip in the next loop
+          const output = argv[++i];
+          if (!output) {
+            throw new Error('Expected a value to be provided after --output');
+          }
+          args.output = output;
+          break;
+        }
+        case '--quiet':
+        case '-q':
+          args.quiet = true;
+          break;
+        default:
+          if (!arg.startsWith('-')) {
+            args.entry = arg;
+          }
+          break;
+      }
+    }
+
+    return args;
+  },
+
+  outputSystemInfo(args, info) {
+    try {
+      fs.accessSync(path.join(args.output, '..'), fs.constants.RDWD_OK);
+      fs.writeFileSync(args.output, JSON.stringify(info, null, 2), 'utf-8');
+    } catch (err) {
+      console.log(`Couldn't create system info file: ${err}`);
+    }
+
+    if (!args.quiet) {
+      console.log(JSON.stringify(info, null, 2));
+    }
+  },
+
+  fetchSystemInfo() {
+    const yaml = setup({}, logger);
+
+    const info = {
+      ReportDate: new Date(),
+      MachineName: os.hostname(),
+      Contrast: {
+        Url: yaml.api.url,
+        Proxy: yaml.api.proxy,
+        Server: {
+          Name: yaml._flat['server.name'],
+        },
+        Agent: {
+          Name: '@contrast/agent',
+          Version: pkg.version,
+        },
+      },
+      Node: {
+        Version: process.version
+      },
+      PM2: isUsingPM2(),
+      OperatingSystem: {
+        Architecture: os.arch(),
+        Name: os.type(),
+        Version: os.release(),
+        KernelVersion: os.version(),
+        CPU: {
+          type: os.cpus()[0].model,
+          count: os.cpus().length,
+        }
+      },
+      Host: {
+        isDocker: isContainer(),
+        Memory: {
+          Total: (os.totalmem() / 1e6).toFixed(0).concat(' MB'),
+          Free: (os.freemem() / 1e6).toFixed(0).concat(' MB'),
+          Used: ((os.totalmem() - os.freemem()) / 1e6).toFixed(0).concat(' MB'),
+        }
+      },
+    };
+
+    return info;
+  }
+};
+module.exports = diagnostics;
+
+// only run if this file is being executed as an entry script
+// istanbul ignore next
+
+if (require.main === module) {
+  const args = diagnostics.parseArgv(process.argv.slice(2));
+
+  if (args.help) {
+    console.log(HELP_MESSAGE);
+  } else {
+    const info = diagnostics.fetchSystemInfo();
+    diagnostics.outputSystemInfo(args, info);
+  }
+}