@contrast/instrumentation 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# `@contrast/instrumentation`
+
+Shared hooks and patches between Protect and Assess components

package/lib/index.js

@@ -0,0 +1,33 @@
+/*
+ * 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';
+module.exports = function(core) {
+  const installers = {
+    ...require('./mongodb')(core)
+  };
+
+  return core.instrumentation = {
+    instrument(opts) {
+      const { moduleName } = opts;
+      if (!moduleName || !installers[moduleName]) {
+        core.logger.error('Unable to instrument non-existent hook: %s', moduleName);
+        return;
+      }
+      installers[moduleName](opts);
+    },
+  };
+
+};

package/lib/mongodb.js

@@ -0,0 +1,53 @@
+/*
+ * 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 { get } = require('./utils');
+
+module.exports = function(core) {
+  const {
+    patcher,
+    depHooks
+  } = core;
+
+  return {
+    'mongodb'(opts) {
+      const { file, version, patchObjects } = opts;
+      const module = {
+        name: 'mongodb',
+        version
+      };
+      if (file) {
+        module.file = file;
+      }
+      depHooks.resolve(module, (mongodb, { version: semVer }) => {
+        patchObjects.forEach((obj) => {
+          const { name, methods, patchName, ...patcherOpts } = obj;
+          methods.forEach((method) => {
+            const patchObj = get(mongodb, patchName || name);
+            const { preHookFn } = patcherOpts;
+            patcher.patch(patchObj, method, {
+              name: name ? `mongodb.${name}.${method}` : `mongodb.${method}`,
+              pre: (ctx) => {
+                preHookFn(ctx, semVer);
+              },
+              ...patcherOpts
+            });
+          });
+        });
+      });
+    }
+  };
+};

package/lib/utils.js

@@ -0,0 +1,26 @@
+/*
+ * 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';
+
+function get(obj, name) {
+  if (!name) return obj;
+  let nest = obj;
+  name.split('.').forEach((prop) => {
+    nest = nest[prop];
+  });
+  return nest;
+}
+
+module.exports = { get };

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@contrast/instrumentation",
+  "version": "1.0.0",
+  "description": "Shared hooks and patches between Protect and Assess components",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
+  "files": [
+    "lib/"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "engines": {
+    "npm": ">=6.13.7 <7 || >= 8.3.1",
+    "node": ">= 14.15.0"
+  },
+  "scripts": {
+    "test": "../scripts/test.sh"
+  }
+}