@contrast/assess 1.5.0 → 1.7.0

package/lib/dataflow/sinks/install/marsdb.js

@@ -0,0 +1,135 @@
+/*
+ * 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 util = require('util');
+const { patchType } = require('../common');
+const {
+  traverseValues,
+  Rule,
+  DataflowTag: {
+    ALPHANUM_SPACE_HYPHEN,
+    LIMITED_CHARS,
+    UNTRUSTED,
+    STRING_TYPE_CHECKED,
+    CUSTOM_VALIDATED_NOSQL_INJECTION,
+  },
+} = require('@contrast/common');
+
+const collectionMethods = ['find', 'findOne', 'update', 'remove'];
+const querySafeTags = [
+  LIMITED_CHARS,
+  ALPHANUM_SPACE_HYPHEN,
+  STRING_TYPE_CHECKED,
+  CUSTOM_VALIDATED_NOSQL_INJECTION,
+];
+
+module.exports = function(core) {
+  const {
+    depHooks,
+    logger,
+    patcher,
+    scopes: { sources, instrumentation },
+    assess: {
+      dataflow: {
+        tracker,
+        sinks: { isVulnerable, reportFindings },
+        eventFactory: { createSinkEvent },
+      },
+    },
+  } = core;
+
+  const instr = core.assess.dataflow.sinks.marsdb = {};
+  const inspect = patcher.unwrap(util.inspect);
+
+  function getVulnerabilityInfo(query) {
+    let vulnInfo = null;
+    if (!query) return vulnInfo;
+
+    traverseValues(query, (path, type, value) => {
+      const strInfo = tracker.getData(value);
+      if (strInfo && isVulnerable(UNTRUSTED, querySafeTags, strInfo.tags)) {
+        vulnInfo = { path, strInfo };
+        return true;
+      }
+    });
+
+    return vulnInfo;
+  }
+
+  function patchCollection(marsdb, method) {
+    const proto = marsdb.Collection.prototype;
+    const name = `marsdb.Collection.prototype.${method}`;
+
+    if (!proto[method]) {
+      logger.trace({ name }, `marsdb method ${method} not found!`);
+      return;
+    }
+
+    patcher.patch(proto, method, {
+      name,
+      patchType,
+      around(next, data) {
+        const sourceCtx = sources.getStore()?.assess;
+        if (!sourceCtx || instrumentation.isLocked()) {
+          return next();
+        }
+
+        const argIdx = 0;
+        const result = getVulnerabilityInfo(data.args[argIdx]);
+        if (!result) {
+          return next();
+        }
+
+        const { strInfo } = result;
+        const args = data.args.map((arg, idx) => ({
+          value: inspect(arg),
+          tracked: idx === argIdx,
+        }));
+
+        const sinkEvent = createSinkEvent({
+          args,
+          context: `marsdb.Collection.${method}(${args.map((a) => a.value)})`,
+          history: [strInfo],
+          object: {
+            tracked: false,
+            value: 'marsdb.Collection',
+          },
+          name,
+          result: strInfo.result,
+          source: `P${argIdx}`,
+          stacktraceOpts: {
+            constructorOpt: data.hooked,
+          },
+          tags: strInfo.tags,
+        });
+
+        if (sinkEvent) {
+          reportFindings({ ruleId: Rule.NOSQL_INJECTION_MONGO, sinkEvent });
+        }
+
+        return next();
+      },
+    });
+  }
+
+  instr.install = function() {
+    depHooks.resolve({ name: 'marsdb' }, (marsdb) => {
+      collectionMethods.forEach((method) => patchCollection(marsdb, method));
+    });
+  };
+
+  return instr;
+};

package/lib/dataflow/sinks/install/mongodb.js

@@ -0,0 +1,322 @@
+/*
+ * 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 util = require('util');
+const {
+  DataflowTag: {
+    UNTRUSTED,
+    ALPHANUM_SPACE_HYPHEN,
+    CUSTOM_VALIDATED,
+    CUSTOM_VALIDATED_NOSQL_INJECTION,
+    LIMITED_CHARS,
+    STRING_TYPE_CHECKED,
+  },
+  Rule: { NOSQL_INJECTION_MONGO },
+  isNonEmptyObject,
+  traverseValues,
+  isString
+} = require('@contrast/common');
+const utils = require('../../tag-utils');
+const { patchType, filterSafeTags } = require('../common');
+
+const collectionMethods = [
+  'find',
+  'findOne',
+  'findAndModify',
+  'findOneAndDelete',
+  'findOneAndReplace',
+  'findOneAndUpdate',
+  'remove',
+  'replaceOne',
+  'update',
+  'updateOne',
+  'updateMany',
+  'deleteOne',
+  'deleteMany',
+];
+const dbMethods = [
+  'command',
+  'eval'
+];
+
+const querySafeTags = [
+  ALPHANUM_SPACE_HYPHEN,
+  CUSTOM_VALIDATED,
+  CUSTOM_VALIDATED_NOSQL_INJECTION,
+  LIMITED_CHARS,
+  STRING_TYPE_CHECKED,
+];
+
+module.exports = function(core) {
+  const {
+    config,
+    depHooks,
+    logger,
+    patcher,
+    scopes: { sources, instrumentation },
+    assess: {
+      dataflow: {
+        tracker,
+        sinks: { isVulnerable, runInActiveSink, isLocked, reportFindings, reportSafePositive },
+        eventFactory: { createSinkEvent }
+      }
+    }
+  } = core;
+
+  const inspect = patcher.unwrap(util.inspect);
+  const instr = core.assess.dataflow.sinks.mongodb = {};
+
+  instr.getVulnerabilityInfo = function getVulnerabilityInfo(query) {
+    let vulnInfo = null;
+    let reportSafe = null;
+
+    if (isString(query)) {
+      const strInfo = tracker.getData(query);
+      if (strInfo) {
+        if (isVulnerable(UNTRUSTED, querySafeTags, strInfo.tags)) {
+          vulnInfo = { strInfo };
+        } else {
+          reportSafe = { strInfo };
+        }
+      }
+
+      return { vulnInfo, reportSafe };
+    }
+
+    if (!isNonEmptyObject(query)) return { vulnInfo, reportSafe };
+
+    traverseValues(query, (path, _type, value) => {
+      const strInfo = tracker.getData(value);
+      if (strInfo) {
+        if (isVulnerable(UNTRUSTED, querySafeTags, strInfo.tags)) {
+          vulnInfo = { path, strInfo };
+          return true; // halts traversal
+        } else {
+          reportSafe = { path, strInfo };
+        }
+      }
+    });
+
+    return { vulnInfo, reportSafe };
+  };
+
+  instr.install = function() {
+    depHooks.resolve({ name: 'mongodb' }, (mongodb, version) => {
+      patchCollection(mongodb, version);
+      patchDatabase(mongodb, version);
+    });
+  };
+
+  return instr;
+
+  function patchCollection(mongodb, version) {
+    for (const method of collectionMethods) {
+      const proto = mongodb.Collection.prototype;
+      const name = `mongodb.Collection.prototype.${method}`;
+
+      if (!proto[method]) {
+        logger.trace({ name, version }, 'method not found - skipping instrumentation');
+        continue;
+      }
+
+      patcher.patch(proto, method, {
+        name,
+        patchType,
+        around(next, data) {
+          const { obj, args: origArgs } = data;
+          const sourceCtx = sources.getStore()?.assess;
+
+          if (isLocked(NOSQL_INJECTION_MONGO) || instrumentation.isLocked() || !sourceCtx) {
+            return next();
+          }
+
+          const argIdx = 0;
+          try {
+            const { vulnInfo, reportSafe } = instr.getVulnerabilityInfo(origArgs[argIdx]);
+
+            if (!vulnInfo) {
+              reportSafe && config.assess.safe_positives.enable && reportSafePositive({
+                name,
+                ruleId: NOSQL_INJECTION_MONGO,
+                safeTags: filterSafeTags(querySafeTags, reportSafe.strInfo),
+                strInfo: {
+                  value: inspect(origArgs[argIdx]),
+                  tags: getAdjustedQueryTags(reportSafe.path, reportSafe.strInfo, inspect(origArgs[argIdx])),
+                },
+              });
+              return method === 'findOne' ? runInActiveSink(NOSQL_INJECTION_MONGO, async () => await next()) : next();
+            }
+
+            const { path, strInfo } = vulnInfo;
+            const objName = getObjectName(obj);
+            const args = origArgs.map((arg, idx) => ({
+              value: inspect(arg),
+              tracked: idx === argIdx,
+            }));
+
+            const tags = getAdjustedQueryTags(path, strInfo, args[argIdx].value);
+            const resultVal = args[args.length - 1].value.startsWith('[Function') ? '' : 'Promise';
+            const sinkEvent = createSinkEvent({
+              args,
+              context: `${objName}.${method}(${args.map((a) => a.value)})`,
+              history: [strInfo],
+              object: {
+                tracked: false,
+                value: 'mongodb.Collection',
+              },
+              name,
+              result: {
+                tracked: false,
+                value: resultVal,
+              },
+              source: `P${argIdx}`,
+              stacktraceOpts: {
+                constructorOpt: data.hooked,
+              },
+              tags,
+            });
+
+            if (sinkEvent) {
+              reportFindings({ ruleId: NOSQL_INJECTION_MONGO, sinkEvent });
+            }
+          } catch (err) {
+            core.logger.error({ name, err }, 'assess sink analysis failed');
+          }
+
+          if (method === 'findOne') {
+            // `findOne` will call `find` so don't analyze in nested call
+            return runInActiveSink(NOSQL_INJECTION_MONGO, async () => await next());
+          }
+
+          return next();
+        },
+      });
+    }
+  }
+
+  function patchDatabase(mongodb, version) {
+    for (const method of dbMethods) {
+      const proto = mongodb.Db.prototype;
+      const name = `mongodb.Db.prototype.${method}`;
+
+      if (!proto[method]) {
+        logger.trace({ name, version }, 'method not found - skipping instrumentation');
+        continue;
+      }
+
+      patcher.patch(proto, method, {
+        name,
+        patchType,
+        around(next, data) {
+          const { obj, args: origArgs } = data;
+          const sourceCtx = sources.getStore()?.assess;
+
+          if (isLocked(NOSQL_INJECTION_MONGO) || instrumentation.isLocked() || !sourceCtx) {
+            return next();
+          }
+
+          const argIdx = 0;
+          try {
+            const { vulnInfo, reportSafe } = instr.getVulnerabilityInfo(origArgs[argIdx]);
+
+            if (!vulnInfo) {
+              const tags = reportSafe?.path ? getAdjustedQueryTags(reportSafe.path, reportSafe.strInfo, inspect(origArgs[argIdx])) : reportSafe?.strInfo?.tags;
+              reportSafe && config.assess.safe_positives.enable && reportSafePositive({
+                name,
+                ruleId: NOSQL_INJECTION_MONGO,
+                safeTags: filterSafeTags(querySafeTags, reportSafe.strInfo),
+                strInfo: {
+                  value: inspect(origArgs[argIdx]),
+                  tags
+                },
+              });
+              return method === 'eval' ? runInActiveSink(NOSQL_INJECTION_MONGO, async () => await next()) : next();
+            }
+
+            const { path, strInfo } = vulnInfo;
+            const objName = getObjectName(obj, 'Db');
+            const args = origArgs.map((arg, idx) => ({
+              value: isString(arg) ? arg : inspect(arg),
+              tracked: idx === argIdx,
+            }));
+
+            const tags = path ? getAdjustedQueryTags(path, strInfo, args[argIdx].value) : strInfo?.tags;
+            const resultVal = args[args.length - 1].value.startsWith('[Function') ? '' : 'Promise';
+            const sinkEvent = createSinkEvent({
+              args,
+              context: `${objName}.${method}(${args.map((a) => a.value)})`,
+              history: [strInfo],
+              object: {
+                tracked: false,
+                value: 'mongodb.Db',
+              },
+              name,
+              result: {
+                tracked: false,
+                value: resultVal,
+              },
+              source: `P${argIdx}`,
+              stacktraceOpts: {
+                constructorOpt: data.hooked,
+              },
+              tags,
+            });
+
+            if (sinkEvent) {
+              reportFindings({ ruleId: NOSQL_INJECTION_MONGO, sinkEvent });
+            }
+          } catch (err) {
+            core.logger.error({ name, err }, 'assess sink analysis failed');
+          }
+
+          if (method === 'eval') {
+            // `eval` will call `command` so don't analyze in nested call
+            return runInActiveSink(NOSQL_INJECTION_MONGO, async () => await next());
+          }
+
+          return next();
+        },
+      });
+    }
+  }
+
+  function getObjectName(obj, entity) {
+    let name = '';
+    name += obj.s?.namespace?.db || 'db';
+
+    if (entity !== 'Db') {
+      name += '.';
+      name += obj.s?.namespace?.collection || 'collection';
+    }
+
+    return name;
+  }
+
+  function getAdjustedQueryTags(path, strInfo, argString) {
+    const { tags } = strInfo;
+    let idx = -1;
+    for (const str of [...path, strInfo.value]) {
+      idx = argString.indexOf(str, idx);
+      if (idx == -1) {
+        idx = -1;
+        break;
+      }
+    }
+
+    return idx > 0 ? utils.createAppendTags([], tags, idx) : strInfo.tags;
+  }
+};

package/lib/dataflow/sinks/install/mssql.js

@@ -15,15 +15,19 @@
 
 'use strict';
 
-const { Rule, isString } = require('@contrast/common');
+const {
+  DataflowTag: { UNTRUSTED, SQL_ENCODED, LIMITED_CHARS, CUSTOM_VALIDATED, CUSTOM_ENCODED },
+  Rule: { SQL_INJECTION },
+  isString
+} = require('@contrast/common');
 const { createModuleLabel } = require('../../propagation/common');
 const { patchType } = require('../common');
 
-const SAFE_TAGS = [
-  'sql-encoded',
-  'limited-chars',
-  'custom-validated',
-  'custom-encoded',
+const safeTags = [
+  SQL_ENCODED,
+  LIMITED_CHARS,
+  CUSTOM_VALIDATED,
+  CUSTOM_ENCODED,
 ];
 
 module.exports = function (core) {
@@ -34,7 +38,7 @@ module.exports = function (core) {
     assess: {
       dataflow: {
         tracker,
-        sinks: { isVulnerable, reportFindings },
+        sinks: { isVulnerable, isLocked, reportFindings },
         eventFactory: { createSinkEvent },
       },
     },
@@ -42,10 +46,15 @@ module.exports = function (core) {
 
   const pre = (name, obj, version) => (data) => {
     const store = sources.getStore()?.assess;
-    if (!store || !data.args[0] || !isString(data.args[0])) return;
+    if (
+      !store ||
+      !data.args[0] ||
+      !isString(data.args[0]) ||
+      isLocked(SQL_INJECTION)
+    ) return;
 
     const strInfo = tracker.getData(data.args[0]);
-    if (!strInfo || !isVulnerable('untrusted', SAFE_TAGS, strInfo.tags)) {
+    if (!strInfo || !isVulnerable(UNTRUSTED, safeTags, strInfo.tags)) {
       return;
     }
 
@@ -71,7 +80,7 @@ module.exports = function (core) {
 
     if (event) {
       reportFindings({
-        ruleId: Rule.SQL_INJECTION,
+        ruleId: SQL_INJECTION,
         sinkEvent: event,
       });
     }

package/lib/dataflow/sinks/install/mysql.js

@@ -0,0 +1,138 @@
+/*
+ * 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 { patchType } = require('../common');
+const {
+  Rule: { SQL_INJECTION },
+  isString,
+  DataflowTag: {
+    CUSTOM_ENCODED_SQL_INJECTION,
+    CUSTOM_ENCODED,
+    CUSTOM_VALIDATED_SQL_INJECTION,
+    CUSTOM_VALIDATED,
+    SQL_ENCODED,
+    LIMITED_CHARS,
+    UNTRUSTED
+  },
+} = require('@contrast/common');
+
+const safeTags = [
+  CUSTOM_ENCODED_SQL_INJECTION,
+  CUSTOM_ENCODED,
+  CUSTOM_VALIDATED_SQL_INJECTION,
+  CUSTOM_VALIDATED,
+  SQL_ENCODED,
+  LIMITED_CHARS,
+];
+
+module.exports = function (core) {
+  const {
+    depHooks,
+    patcher,
+    scopes: { sources },
+    assess: {
+      dataflow: {
+        tracker,
+        sinks: { isVulnerable, isLocked, reportFindings },
+        eventFactory: { createSinkEvent },
+      },
+    },
+  } = core;
+
+  function getValueFromArgs([value]) {
+    if (isString(value)) {
+      return value;
+    }
+
+    if (isString(value.sql)) {
+      return value.sql;
+    }
+  }
+
+  const pre = (module, file, obj) => (data) => {
+    const store = sources.getStore()?.assess;
+    if (
+      !store ||
+      !data.args[0] ||
+      isLocked(SQL_INJECTION)
+    ) return;
+
+    const val = getValueFromArgs(data.args);
+    if (!val) return;
+
+    const strInfo = tracker.getData(val);
+    if (!strInfo || !isVulnerable(UNTRUSTED, safeTags, strInfo.tags)) {
+      return;
+    }
+
+    const event = createSinkEvent({
+      name: `${module}/${file}`,
+      history: [strInfo],
+      object: {
+        value: `${module}.${obj}`,
+        tracked: false,
+      },
+      args: [
+        {
+          value: strInfo.value,
+          tracked: true,
+        },
+      ],
+      tags: strInfo.tags,
+      source: 'P0',
+      stacktraceOpts: {
+        contructorOpt: data.hooked,
+      },
+    });
+
+    if (event) {
+      reportFindings({
+        ruleId: SQL_INJECTION,
+        sinkEvent: event,
+      });
+    }
+  };
+
+  core.assess.dataflow.sinks.mysql = {
+    install() {
+      depHooks.resolve(
+        { name: 'mysql', file: 'lib/Connection' },
+        (Connection) => {
+          patcher.patch(Connection.prototype, 'query', {
+            name: 'Connection.prototype.query',
+            patchType,
+            pre: pre('mysql', 'lib/Connection.query', 'Connection')
+          });
+        },
+      );
+      depHooks.resolve(
+        { name: 'mysql2', file: 'lib/connection' },
+        (connection) => {
+          ['query', 'execute'].forEach((method) => {
+            patcher.patch(connection.prototype, `${method}`, {
+              name: `connection.prototype.${method}`,
+              patchType,
+              pre: pre('mysql2', `lib/connection.Connection.${method}`, 'connection')
+            });
+          });
+        },
+      );
+    },
+  };
+
+  return core.assess.dataflow.sinks.mysql;
+};