@contrast/assess 1.25.0 → 1.26.1

package/lib/dataflow/propagation/install/ejs/template.js

@@ -37,7 +37,8 @@ module.exports = function (core) {
     rewriter,
   } = core;
 
-  const REWRITE_OPTS = { inject: false, wrap: false };
+  /** @type {import('@contrast/rewriter').RewriteOpts} */
+  const REWRITE_OPTS = { isModule: false, inject: false, wrap: false, trim: true };
   const WRAPPER_PREFIX = join([
     'function tempWrapper() {',
     'function __append(s) { if (s !== undefined && s !== null) __output += s }'
@@ -63,7 +64,7 @@ module.exports = function (core) {
             if (!getSourceContext(PROPAGATOR)) return;
 
             try {
-              const { code } = rewriter.rewrite(`${WRAPPER_PREFIX}${data.obj.source}${WRAPPER_SUFFIX}`, REWRITE_OPTS);
+              const { code } = rewriter.rewriteSync(`${WRAPPER_PREFIX}${data.obj.source}${WRAPPER_SUFFIX}`, REWRITE_OPTS);
               data.obj.source = code.substring(code.indexOf('{') + 1, code.lastIndexOf('}'));
             } catch (err) {
               logger.error(

package/lib/dataflow/propagation/install/pug/index.js

@@ -16,6 +16,9 @@
 
 const { patchType } = require('../../common');
 
+/** @type {import('@contrast/rewriter').RewriteOpts} */
+const REWRITE_OPTS = { isModule: false, inject: false, wrap: false, trim: true };
+
 module.exports = function (core) {
   const store = { lock: true, name: 'assess:propagators:pug-compile' };
   const {
@@ -23,8 +26,6 @@ module.exports = function (core) {
     patcher, logger, rewriter, depHooks,
   } = core;
 
-  const rewriterOpts = { isModule: false, wrap: false };
-
   const pugInstrumentation = {
     install() {
       depHooks.resolve(
@@ -42,7 +43,7 @@ module.exports = function (core) {
               postCodeGen: (value, options) => {
                 try {
                   return instrumentation.run(store,
-                    () => rewriter.rewrite(value, rewriterOpts).code
+                    () => rewriter.rewriteSync(value, REWRITE_OPTS).code
                   );
                 } catch (err) {
                   logger.warn({ err, funcKey: data.funcKey }, 'Failed to rewrite pug code');

package/lib/dataflow/propagation/install/string/split.js

@@ -25,7 +25,7 @@ module.exports = function(core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      eventFactory: { createPropagationEvent },
+      eventFactory,
       dataflow: { tracker }
     }
   } = core;
@@ -53,6 +53,40 @@ module.exports = function(core) {
           const objInfo = tracker.getData(obj);
           if (!objInfo || obj === result[0]) return;
 
+          const args = origArgs.map((arg) => {
+            const argInfo = tracker.getData(arg);
+            return {
+              value: argInfo ? argInfo.value : inspect(arg),
+              tracked: !!argInfo
+            };
+          });
+
+          const event = eventFactory.createPropagationEvent({
+            name,
+            moduleName: 'String',
+            methodName: 'prototype.split',
+            context: `'${objInfo.value}'.split(${join(args.map(a => a.value), ', ')})`,
+            history: [objInfo],
+            object: {
+              value: obj,
+              tracked: true,
+            },
+            args,
+            tags: {},
+            result: {
+              value: join(result),
+              tracked: false
+            },
+            stacktraceOpts: {
+              constructorOpt: hooked,
+              prependFrames: [orig]
+            },
+            source: 'O',
+            target: 'R'
+          });
+
+          if (!event) return;
+
           let idx = 0;
           for (let i = 0; i < result.length; i++) {
             const res = result[i];
@@ -64,40 +98,9 @@ module.exports = function(core) {
               const tags = createSubsetTags(objInfo.tags, start, res.length);
               if (!tags) continue;
 
-              const args = origArgs.map((arg) => {
-                const argInfo = tracker.getData(arg);
-                return {
-                  value: argInfo ? argInfo.value : inspect(arg),
-                  tracked: !!argInfo
-                };
-              });
-              const event = createPropagationEvent({
-                name,
-                moduleName: 'String',
-                methodName: 'prototype.split',
-                context: `'${objInfo.value}'.split(${join(args.map(a => a.value), ', ')})`,
-                history: [objInfo],
-                object: {
-                  value: obj,
-                  tracked: true,
-                },
-                args,
-                tags,
-                result: {
-                  value: join(result),
-                  tracked: false
-                },
-                stacktraceOpts: {
-                  constructorOpt: hooked,
-                  prependFrames: [orig]
-                },
-                source: 'O',
-                target: 'R'
-              });
-
-              if (!event) continue;
-
-              const { extern } = tracker.track(res, event);
+              const metadata = { ...event, tags };
+              eventFactory.createdEvents.add(metadata);
+              const { extern } = tracker.track(res, metadata);
 
               if (extern) {
                 data.result[i] = extern;

package/lib/get-policy.js

@@ -20,6 +20,8 @@ const {
   ResponseScanningRule,
   SessionConfigurationRule,
   Event,
+  join,
+  toLowerCase,
 } = require('@contrast/common');
 
 const rulesIds = Object.values({
@@ -28,6 +30,38 @@ const rulesIds = Object.values({
   ...SessionConfigurationRule,
 });
 
+function buildUriPathRegExp(urls) {
+  let regExpNeeded = false;
+  for (const url of urls) {
+    if (regExpCheck(url)) {
+      regExpNeeded = true;
+    }
+  }
+  if (regExpNeeded) {
+    const rx = new RegExp(`^${join(urls, '|')}$`);
+
+    return (uriPath) => rx ? rx.test(uriPath) : false;
+  }
+
+  return (uriPath) => urls.some((url) => url === uriPath);
+}
+
+function createUriPathMatcher(urls) {
+  if (urls.length) {
+    return buildUriPathRegExp(urls);
+  } else {
+    return () => true;
+  }
+}
+
+function regExpCheck(str) {
+  return str.indexOf('*') > 0 ||
+    str.indexOf('.') > 0 ||
+    str.indexOf('+') > 0 ||
+    str.indexOf('?') > 0 ||
+    str.indexOf('\\') > 0;
+}
+
 /**
  * @param {{
  *  config: import('@contrast/config').Config,
@@ -37,32 +71,102 @@ const rulesIds = Object.values({
  * @returns {import('@contrast/common').Installable}
  */
 module.exports = function assess(core) {
-  const { logger, messages } = core;
+  const { config, logger, messages } = core;
 
   const enabledRules = new Set(rulesIds);
+  const exclusions = {
+    url: [],
+  };
+
+  function compileExclusions(settings) {
+    // reset global exclusion state
+    for (const key of Object.keys(exclusions)) {
+      exclusions[key] = [];
+    }
+
+    const rawDtmList = [
+      // todo: NODE-3281 input exclusions
+      ...(settings?.exclusions?.url || [])
+    ].filter((exclusion) => exclusion.modes.includes('assess'));
+
+    if (!rawDtmList.length) {
+      return;
+    }
+
+    for (const dtm of rawDtmList) {
+      dtm.type = dtm.type || 'URL';
+
+      const { name, assess_rules, urls, type } = dtm;
+      const key = toLowerCase(type);
+      try {
+        const e = {
+          name,
+          rules: new Set(assess_rules),
+        };
+        e.matchesUriPath = createUriPathMatcher(urls);
+        exclusions[key].push(e);
+      } catch (err) {
+        logger.error({ err, dtm }, 'failed to process exclusion');
+      }
+    }
+  }
 
   messages.on(Event.SERVER_SETTINGS_UPDATE, (msg) => {
-    if (!msg.assess) return;
-
-    for (const ruleId of rulesIds) {
-      const enable = msg.assess[ruleId]?.enable;
-      if (enable === true) {
-        enabledRules.add(ruleId);
-        if (ruleId === Rule.NOSQL_INJECTION) enabledRules.add(Rule.NOSQL_INJECTION_MONGO);
-      } else if (enable === false) {
-        if (ruleId === Rule.NOSQL_INJECTION) enabledRules.delete(Rule.NOSQL_INJECTION_MONGO);
-        enabledRules.delete(ruleId);
+    if (!config.getEffectiveValue('assess.enable')) return;
+
+    if (msg.assess) {
+      for (const ruleId of rulesIds) {
+        const enable = msg.assess[ruleId]?.enable;
+        if (enable === true) {
+          enabledRules.add(ruleId);
+          if (ruleId === Rule.NOSQL_INJECTION) enabledRules.add(Rule.NOSQL_INJECTION_MONGO);
+        } else if (enable === false) {
+          if (ruleId === Rule.NOSQL_INJECTION) enabledRules.delete(Rule.NOSQL_INJECTION_MONGO);
+          enabledRules.delete(ruleId);
+        }
       }
     }
-    logger.info({
-      enabledRules: Array.from(enabledRules)
-    }, 'Assess policy updated');
+
+    if (msg.exclusions) {
+      compileExclusions(msg);
+    }
+
+    logger.info({ enabledRules: Array.from(enabledRules) }, 'Assess policy updated');
   });
 
-  return core.assess.getPolicy = function getPolicy() {
+  /**
+   * This gets called by assess.makeSourceContext(). We return copy of policy to avoid
+   * inconsistent behavior if policy is updated during request handling.
+   */
+  return core.assess.getPolicy = function getPolicy({ uriPath } = {}) {
+    const _enabledRules = new Set(enabledRules);
+
+    // Evaluate url exclusions for current request.
+    // If one matches and applies to all rules, we return `null` for the policy value,
+    // which will disable assess for the request. If specific rules are disabled, we
+    // just removed them from the request policy's set of `enabledRules`.
+    for (const urlExclusion of exclusions.url) {
+      if (urlExclusion.matchesUriPath(uriPath)) {
+        if (!urlExclusion.rules?.size) {
+          core.logger.debug({
+            name: urlExclusion.name
+          }, 'all assess rules disabled by URL exclusion');
+          return null;
+        } else {
+          for (const ruleId of urlExclusion.rules) {
+            if (_enabledRules.has(ruleId)) _enabledRules.delete(ruleId);
+          }
+          core.logger.debug({
+            name: urlExclusion.name,
+            rules: Array.from(urlExclusion.rules),
+          }, 'assess rules disabled by URL exclusion');
+        }
+      }
+    }
+
     // creates copy of local policy for request store
     return {
-      enabledRules: new Set(enabledRules),
+      enabledRules: new Set(_enabledRules),
     };
   };
 };

package/lib/get-source-context.js

@@ -38,7 +38,8 @@ module.exports = function(core) {
   return core.assess.getSourceContext = function getSourceContext(type, ...rest) {
     const ctx = sources.getStore()?.assess;
 
-    if (!ctx || instrumentation.isLocked()) return null;
+    // policy will not exist if assess is altogether disabled for the active request e.g. url exclusion
+    if (!ctx || !ctx?.policy || instrumentation.isLocked()) return null;
 
     switch (type) {
       case InstrumentationType.PROPAGATOR: {

package/lib/make-source-context.js

@@ -54,7 +54,7 @@ module.exports = function(core) {
       return {
         propagationEventsCount: 0,
         sourceEventsCount: 0,
-        policy: getPolicy(),
+        policy: getPolicy({ uriPath }),
         reqData: {
           ip: req.socket.remoteAddress,
           httpVersion: req.httpVersion,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/assess",
-  "version": "1.25.0",
+  "version": "1.26.1",
   "description": "Contrast service providing framework-agnostic Assess support",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",