@contrast/agentify 1.2.0 → 1.3.1

package/lib/index.js

@@ -15,6 +15,8 @@
 
 'use strict';
 
+const fs = require('fs');
+const path = require('path');
 const Module = require('module');
 
 const defaultOpts = {
@@ -25,20 +27,22 @@ const defaultOpts = {
     'deadzones',
     'scopes',
     'sources',
+    'architectureComponents',
     'assess',
     'protect',
     'depHooks',
+    'enhancedLibraryUsage',
     'rewriteHooks',
-    'functionHooks',
+    'functionHooks'
   ]
 };
 
-module.exports = function(deps) {
+module.exports = function(core) {
   // compose add'l local services
-  require('./sources')(deps);
-  require('./contrast-methods')(deps);
-  require('./function-hooks')(deps);
-  require('./rewrite-hooks')(deps);
+  require('./sources')(core);
+  require('./contrast-methods')(core);
+  require('./function-hooks')(core);
+  require('./rewrite-hooks')(core);
 
   /**
    * The interface is a function, which when called, will hook runMain
@@ -56,10 +60,10 @@ module.exports = function(deps) {
       opts = { ...defaultOpts, ...opts };
     }
 
-    return new Agent(deps, opts);
+    return new Agent(core, opts);
   }
 
-  deps.agentify = agentify;
+  core.agentify = agentify;
 
   return agentify;
 };
@@ -67,16 +71,16 @@ module.exports = function(deps) {
 class Agent {
   /**
    *
-   * @param {object} deps dependencies
+   * @param {object} core dependencies
    * @param {object} opts
    * @param {function} opts.preRunMain custom function for registering services
    * @param {boolean} opts.install whether to automatically install
    */
-  constructor(deps, opts) {
+  constructor(core, opts) {
     const self = this;
-    const { config, logger } = deps;
+    const { config, logger } = core;
 
-    this.deps = deps;
+    this.core = core;
     this.opts = opts;
     this.runMain = Module.runMain;
 
@@ -89,7 +93,7 @@ class Agent {
         logger.info('Starting the Contrast agent');
         logger.debug({ config }, 'Agent configuration');
 
-        const plugin = await opts.preRunMain(deps);
+        const plugin = await opts.preRunMain(core);
 
         if (opts.install) {
           await self.install();
@@ -101,6 +105,8 @@ class Agent {
       } catch (err) {
         await self.handleInstallFailure(err);
       }
+
+      self.logEffectiveConfig();
       return self.runMain.apply(this, args);
     };
   }
@@ -113,7 +119,7 @@ class Agent {
    * @param {error} err Error thrown during install
    */
   async handleInstallFailure(err) {
-    this.deps.logger.error(
+    this.core.logger.error(
       { err },
       'A fatal agent installation error has occurred. The application will be run without instrumentation.'
     );
@@ -121,13 +127,41 @@ class Agent {
 
   async install() {
     for (const svcName of this.opts.svcList) {
-      this.deps.logger.trace('installing service: %s', svcName);
-      const svc = this.deps[svcName];
+      const svc = this.core[svcName];
       if (svc && svc.install) {
+        this.core.logger.trace('installing service: %s', svcName);
         await svc.install();
       }
     }
   }
+
+  logEffectiveConfig() {
+    const { config, getEffectiveConfig } = this.core;
+
+    if (config._flat['agent.diagnostics.enable'] !== false) {
+      const content = JSON.stringify(getEffectiveConfig(), null, 2).concat('\n\n');
+
+      if (config._flat['agent.diagnostics.quiet'] !== true) {
+        fs.writeFileSync(1, content, 'utf8');
+      }
+
+      let outputDir = config._flat['agent.diagnostics.report_path'];
+      if (!outputDir && config.agent.logger.path) {
+        outputDir = path.join(config.agent.logger.path, '../contrast_effective_config.json');
+      }
+
+      try {
+        fs.writeFileSync(outputDir, content, 'utf-8');
+      } catch (err) {
+        outputDir = path.join(process.cwd(), 'contrast_effective_config.json');
+        try {
+          fs.writeFileSync(outputDir, content, 'utf-8');
+        } catch (err) {
+          fs.writeFileSync(1, `Couldn't create effective config file: ${err}`, 'utf-8');
+        }
+      }
+    }
+  }
 }
 
 module.exports.Agent = Agent;

package/lib/sources.js

@@ -14,73 +14,66 @@
  */
 
 'use strict';
+const patchType = 'http-sources';
 
 module.exports = function(core) {
-  const { depHooks, patcher, logger, scopes: { sources: sourcesStorage } } = core;
-  const sources = core.sources = {};
+  const {
+    instrumentation: { instrument },
+    scopes: { sources: sourcesStorage }
+  } = core;
 
-  sources.install = function install() {
-    depHooks.resolve({ name: 'http' }, http => patchServerEmit(http, 'httpServer'));
-    depHooks.resolve({ name: 'https' }, https => patchServerEmit(https, 'httpsServer'));
-    depHooks.resolve({ name: 'http2' }, http2 => {
-      patchCreateServer(http2, 'http2Server');
-      patchCreateServer(http2, 'http2SecureServer', 'createSecureServer');
-    });
-    depHooks.resolve({ name: 'spdy' }, spdy => patchServerEmit(spdy, 'spdyServer'));
-  };
-
-  function patchServerEmit(serverSource, sourceName) {
-    serverSource.Server.prototype = patcher.patch(serverSource.Server.prototype, 'emit', {
-      name: `${sourceName}.Server.prototype.emit`,
-      patchType: 'http-sources',
-      around: emitAroundHook(sourceName)
-    });
-  }
-
-  function patchCreateServer(serverSource, sourceName, constructorName = 'createServer') {
-    patcher.patch(serverSource, constructorName, {
-      name: sourceName,
-      patchType: 'http-sources',
-      post: createServerPostHook(sourceName)
-    });
-  }
-
-  function createServerPostHook(serverType) {
-    return function(data) {
-      const { result: server } = data;
-      const serverPrototype = server ? Object.getPrototypeOf(server) : null;
-
-      if (!serverPrototype) {
-        logger.error('Unable to patch server prototype, continue without instrumentation');
-        return;
-      }
-
-      patcher.patch(serverPrototype, 'emit', {
-        name: 'Server.prototype.emit',
-        patchType: 'req-async-storage',
-        around: emitAroundHook(serverType)
-      });
-    };
-  }
-
-  function emitAroundHook(serverType) {
-    return function emitAroundHook(next, data) {
+  function aroundHook(serverType) {
+    return function around(next, data) {
       const { args: [event] } = data;
-
       if (event !== 'request') return next();
-
       const store = { serverType };
-
       return sourcesStorage.run(store, next);
     };
   }
 
-  return {
-    install: sources.install,
-    functions: {
-      patchCreateServer,
-      createServerPostHook,
-      emitAroundHook
-    }
+  function install() {
+    [{
+      moduleName: 'http'
+    },
+    {
+      moduleName: 'https'
+    },
+    {
+      moduleName: 'spdy'
+    },
+    {
+      moduleName: 'http2',
+      patchObjectsProps: [
+        {
+          methods: ['createServer', 'createSecureServer'],
+          patchType,
+          patchObjects: [
+            {
+              name: 'Server.prototype',
+              methods: ['emit'],
+              patchType,
+              around: aroundHook('http2')
+            }
+          ]
+        }
+      ]
+    }].forEach(({ moduleName, patchObjectsProps }) => {
+      const patchObjects = patchObjectsProps || [
+        {
+          name: 'Server.prototype',
+          methods: ['emit'],
+          patchType,
+          around: aroundHook(moduleName)
+        }
+      ];
+      instrument({
+        moduleName,
+        patchObjects
+      });
+    });
+  }
+  return core.sources = {
+    install,
+    aroundHook
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agentify",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Configures Contrast agent services and instrumentation within an application",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -16,4 +16,4 @@
   "scripts": {
     "test": "../scripts/test.sh"
   }
-}
+}