@contrast/core 1.10.2 → 1.11.0

package/lib/index.js

@@ -23,6 +23,7 @@ module.exports = function init(core = {}) {
   require('@contrast/config')(core);
   require('./logger-factory')(core);
   require('./effective-config')(core);
+  require('./system-info')(core);
   require('./sensitive-data-masking')(core);
   require('./app-info')(core);
   require('./is-agent-path')(core);

package/lib/system-info/index.js

@@ -0,0 +1,118 @@
+/*
+ * 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');
+
+function isUsingPM2() {
+  const used = !!process.env.pmx;
+  let version = null;
+
+  for (const pathVar of ['npm_package_json', 'PWD']) {
+    const packagePath = process.env[pathVar];
+    if (packagePath) {
+      try {
+        version = require(path.join(packagePath, 'package.json')).dependencies['pm2'];
+      } catch (err) {
+        //
+      }
+    }
+    if (version) break;
+  }
+
+  return { used, version };
+}
+
+function isDocker() {
+  const MOUNTINFO_REGEX = /\/docker\/containers\/(.*?)\//;
+  const CGROUP_REGEX = /:\/docker\/([^/]+)$/;
+
+  try {
+    const results = fs.readFileSync('/proc/self/mountinfo', 'utf8').match(MOUNTINFO_REGEX);
+    if (results) return { isDocker: true, containerID: results[1] };
+  } catch (err) {
+    // else check /proc/self/cgroup
+  }
+
+  try {
+    const results = fs.readFileSync('/proc/self/cgroup', 'utf8').match(CGROUP_REGEX);
+    if (results) return { isDocker: true, containerID: results[1] };
+  } catch (err) {
+    // else check /.dockerenv
+  }
+
+  try {
+    const result = fs.statSync('/.dockerenv');
+    if (result) return { isDocker: true, containerID: undefined };
+  } catch (err) {
+    // if there's not such file we can conclude it's not docker env
+  }
+
+  return { isDocker: false, containerID: undefined };
+}
+
+module.exports = function(core) {
+  // eslint-disable-next-line node/no-extraneous-require
+  const pkg = require('@contrast/protect-agent/package.json');
+  const { config } = core;
+
+  core.getSystemInfo = function() {
+    const appPath = process.cwd();
+
+    const info = {
+      ReportDate: new Date(),
+      MachineName: os.hostname(),
+      Contrast: {
+        Url: config.api.url,
+        Proxy: config.api.proxy,
+        Server: {
+          Name: config.server.name,
+        },
+        Agent: {
+          Name: pkg.name,
+          Version: pkg.version,
+        },
+      },
+      Node: {
+        Version: process.version
+      },
+      OperatingSystem: {
+        Architecture: os.arch(),
+        Name: os.type(),
+        Version: os.release(),
+        KernelVersion: os.version(),
+        CPU: {
+          type: os.cpus()[0].model,
+          count: os.cpus().length,
+        }
+      },
+      Host: {
+        Docker: isDocker(),
+        PM2: isUsingPM2(),
+        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'),
+        }
+      },
+      Application: appPath ? require(path.join(appPath, 'package.json')) : null,
+    };
+
+    return info;
+  };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/core",
-  "version": "1.10.2",
+  "version": "1.11.0",
   "description": "Preconfigured Contrast agent core services and models",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,17 +17,17 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/agentify": "1.3.1",
-    "@contrast/common": "1.3.2",
-    "@contrast/config": "1.5.2",
-    "@contrast/deadzones": "1.0.0",
-    "@contrast/dep-hooks": "1.0.5",
+    "@contrast/agentify": "1.4.0",
+    "@contrast/common": "1.4.0",
+    "@contrast/config": "1.6.0",
+    "@contrast/deadzones": "1.1.0",
+    "@contrast/dep-hooks": "1.1.0",
     "@contrast/fn-inspect": "^3.2.0",
-    "@contrast/instrumentation": "1.0.1",
-    "@contrast/logger": "1.1.2",
-    "@contrast/patcher": "1.1.0",
-    "@contrast/reporter": "1.8.3",
+    "@contrast/instrumentation": "1.1.0",
+    "@contrast/logger": "1.2.0",
+    "@contrast/patcher": "1.2.0",
+    "@contrast/reporter": "1.9.0",
     "@contrast/rewriter": "1.3.1",
-    "@contrast/scopes": "1.2.0"
+    "@contrast/scopes": "1.3.0"
   }
 }