@contrast/assess 1.6.0 → 1.7.0

package/lib/dataflow/sinks/install/express/unvalidated-redirect.js

@@ -0,0 +1,134 @@
+/*
+ * 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,
+    CUSTOM_ENCODED,
+    CUSTOM_VALIDATED,
+    HTML_ENCODED,
+    LIMITED_CHARS,
+    URL_ENCODED,
+  },
+  isString
+} = require('@contrast/common');
+const { patchType, filterSafeTags } = require('../../common');
+const { createSubsetTags } = require('../../../tag-utils');
+
+const ruleId = 'unvalidated-redirect';
+
+module.exports = function (core) {
+  const {
+    depHooks,
+    patcher,
+    config,
+    scopes: { sources },
+    assess: {
+      dataflow: {
+        tracker,
+        sinks: { isVulnerable, reportFindings, reportSafePositive },
+        eventFactory: { createSinkEvent },
+      },
+    },
+  } = core;
+  const unvalidatedRedirect =
+    (core.assess.dataflow.sinks.express.unvalidatedRedirect = {});
+
+  const inspect = patcher.unwrap(util.inspect);
+
+  const safeTags = [
+    CUSTOM_ENCODED,
+    CUSTOM_VALIDATED,
+    HTML_ENCODED,
+    LIMITED_CHARS,
+    URL_ENCODED,
+  ];
+
+  unvalidatedRedirect.install = function () {
+    depHooks.resolve({ name: 'express', file: 'lib/response' }, (Response) => {
+      const name = 'Express.Response.location';
+      patcher.patch(Response, 'location', {
+        name: 'Express.Response.location',
+        patchType,
+        pre: (data) => {
+          const assessStore = sources.getStore()?.assess;
+          if (!assessStore) return;
+
+          let [url] = data.args;
+          if (url === 'back') {
+            url = data.obj.req.get('Referrer');
+          }
+
+          if (!url || !isString(url)) return;
+
+          const strInfo = tracker.getData(url);
+          if (!strInfo) return;
+
+          let urlPathTags = strInfo.tags;
+          if (url.indexOf('?') > -1) {
+            urlPathTags = createSubsetTags(strInfo.tags, 0, url.indexOf('?'));
+          }
+
+          if (urlPathTags && isVulnerable(UNTRUSTED, safeTags, urlPathTags)) {
+            const event = createSinkEvent({
+              args: [{
+                tracked: true,
+                value: strInfo.value,
+              }],
+              context: `response.location(${inspect(strInfo.value)})`,
+              history: [strInfo],
+              name: 'Express.Response.location',
+              object: {
+                tracked: false,
+                value: 'Express.Response',
+              },
+              result: {
+                tracked: false,
+                value: undefined,
+              },
+              tags: urlPathTags,
+              source: 'P0',
+              stacktraceOpts: {
+                constructorOpt: data.hooked,
+              },
+            });
+
+            if (event) {
+              reportFindings({
+                ruleId,
+                sinkEvent: event,
+              });
+            }
+          } else if (config.assess.safe_positives.enable) {
+            reportSafePositive({
+              name,
+              ruleId,
+              safeTags: filterSafeTags(safeTags, strInfo),
+              strInfo: {
+                tags: strInfo.tags,
+                value: strInfo.value,
+              }
+            });
+          }
+        },
+      });
+    });
+  };
+
+  return unvalidatedRedirect;
+};

package/lib/dataflow/sinks/install/fastify/unvalidated-redirect.js

@@ -27,18 +27,39 @@ const {
   },
   isString
 } = require('@contrast/common');
-const { patchType } = require('../../common');
 const { createSubsetTags } = require('../../../tag-utils');
+const { filterSafeTags, patchType } = require('../../common');
+
+const ruleId = 'unvalidated-redirect';
+const getURLArgument = (args) => {
+  if (!Array.isArray(args)) {
+    return { index: null, url: undefined };
+  }
+
+  // url can be first or second argument
+  if (typeof args[0] === 'string') {
+    return {
+      index: 0,
+      url: args[0]
+    };
+  }
+
+  return {
+    index: 1,
+    url: args[1]
+  };
+};
 
 module.exports = function (core) {
   const {
+    config,
     depHooks,
     patcher,
     scopes: { sources },
     assess: {
       dataflow: {
         tracker,
-        sinks: { isVulnerable, reportFindings },
+        sinks: { isVulnerable, reportFindings, reportSafePositive },
         eventFactory: { createSinkEvent },
       },
     },
@@ -56,79 +77,85 @@ module.exports = function (core) {
     URL_ENCODED,
   ];
 
-  /**
-   * Patches `Reply.prototype.redirect` for
-   * `unvalidated-redirect` checking
-   *
-   * @param {Fastify.Reply} Reply outgoing response
-   */
-  const registerUnvalidatedRedirectHandler = (Reply, version) => {
-    patcher.patch(Reply.prototype, 'redirect', {
-      name: 'fastify.Reply.prototype.redirect',
-      patchType,
-      post(data) {
-        const assessStore = sources.getStore()?.assess;
-        if (!assessStore) return;
-
-        const [code] = data.args;
-        // url can be first or second argument
-        const url = typeof code === 'string' ? code : data.args[1];
-
-        if (!url || !isString(url)) return;
-
-        const strInfo = tracker.getData(url);
-        if (!strInfo) return;
-
-        // todo: how does different tag logic play into display ranges?
-
-        let urlPathTags = strInfo.tags;
-        const urlPathEndIdx = url.indexOf('?');
-
-        if (urlPathEndIdx > -1) {
-          urlPathTags = createSubsetTags(strInfo.tags, 0, urlPathEndIdx);
-        }
-
-        if (isVulnerable(UNTRUSTED, safeTags, urlPathTags)) {
-          const event = createSinkEvent({
-            args: [{
+  unvalidatedRedirect.install = function () {
+    const name = 'fastify.Reply.prototype.redirect';
+    depHooks.resolve({ name: 'fastify', file: 'lib/reply' }, (Reply, version) => {
+      patcher.patch(Reply.prototype, 'redirect', {
+        name,
+        patchType,
+        post(data) {
+          const assessStore = sources.getStore()?.assess;
+          if (!assessStore) return;
+
+          const { url, index: valueIndex } = getURLArgument(data.args);
+          if (!url || !isString(url)) return;
+
+          const strInfo = tracker.getData(url);
+          if (!strInfo) return;
+
+          // todo: how does different tag logic play into display ranges?
+
+          let urlPathTags = strInfo.tags;
+          const urlPathEndIdx = url.indexOf('?');
+          if (urlPathEndIdx > -1) {
+            urlPathTags = createSubsetTags(strInfo.tags, 0, urlPathEndIdx);
+          }
+
+          if (isVulnerable(UNTRUSTED, safeTags, urlPathTags)) {
+            const args = [];
+            // in case a status code is provided
+            if (valueIndex) {
+              args.push({
+                tracked: false,
+                value: data.args[0]
+              });
+            }
+            args.push({
               tracked: true,
               value: strInfo.value,
-            }],
-            context: `reply.redirect(${inspect(strInfo.value)})`,
-            history: [strInfo],
-            name: 'fastify.reply.redirect',
-            object: {
-              tracked: false,
-              value: 'fastify.Reply',
-            },
-            result: {
-              tracked: false,
-              value: undefined,
-            },
-            tags: urlPathTags,
-            source: 'P0',
-            stacktraceOpts: {
-              constructorOpt: data.hooked,
-            },
-          });
-
-          if (event) {
-            reportFindings({
-              ruleId: 'unvalidated-redirect', // add Rule.UNVALIDATED_REDIRECT
-              sinkEvent: event,
+            });
+
+            const event = createSinkEvent({
+              args,
+              context: `reply.redirect(${inspect(strInfo.value)})`,
+              history: [strInfo],
+              name: 'fastify.reply.redirect',
+              object: {
+                tracked: false,
+                value: 'fastify.Reply',
+              },
+              result: {
+                tracked: false,
+                value: undefined,
+              },
+              tags: urlPathTags,
+              source: `P${valueIndex}`,
+              stacktraceOpts: {
+                constructorOpt: data.hooked,
+              },
+            });
+
+            if (event) {
+              reportFindings({
+                ruleId,
+                sinkEvent: event,
+              });
+            }
+          } else if (config.assess.safe_positives.enable) {
+            reportSafePositive({
+              name,
+              ruleId,
+              safeTags: filterSafeTags(safeTags, strInfo),
+              strInfo: {
+                tags: strInfo.tags,
+                value: strInfo.value,
+              }
             });
           }
-        }
-      },
+        },
+      });
     });
   };
 
-  unvalidatedRedirect.install = function () {
-    depHooks.resolve(
-      { name: 'fastify', file: 'lib/reply' },
-      registerUnvalidatedRedirectHandler
-    );
-  };
-
   return unvalidatedRedirect;
 };

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

@@ -29,19 +29,25 @@ const {
     URL_ENCODED,
     WEAK_URL_ENCODED,
   },
-  Rule,
+  Rule: { REFLECTED_XSS: ruleId },
 } = require('@contrast/common');
-const { patchType } = require('../common');
+const { patchType, filterSafeTags } = require('../common');
 
 module.exports = function(core) {
   const {
+    config,
     depHooks,
     patcher,
     scopes: { sources },
     assess: {
       dataflow: {
         tracker,
-        sinks: { isVulnerable, reportFindings, isSafeContentType },
+        sinks: {
+          isVulnerable,
+          reportFindings,
+          reportSafePositive,
+          isSafeContentType
+        },
         eventFactory: { createSinkEvent },
       },
     },
@@ -91,7 +97,6 @@ module.exports = function(core) {
           value: data.result,
           tracked: false,
         },
-        ruleId: Rule.REFLECTED_XSS,
         source: 'P0',
         stacktraceOpts: {
           constructorOpt: data.hooked
@@ -101,10 +106,20 @@ module.exports = function(core) {
 
       if (event) {
         reportFindings({
-          ruleId: 'reflected-xss',
+          ruleId,
           sinkEvent: event
         });
       }
+    } else if (config.assess.safe_positives.enable) {
+      reportSafePositive({
+        name,
+        ruleId,
+        safeTags: filterSafeTags(safeTags, strInfo),
+        strInfo: {
+          value: strInfo.value,
+          tags: strInfo.tags,
+        }
+      });
     }
   };
 

package/lib/dataflow/sinks/install/koa/unvalidated-redirect.js

@@ -27,18 +27,21 @@ const {
   },
   isString
 } = require('@contrast/common');
-const { patchType } = require('../../common');
 const { createSubsetTags } = require('../../../tag-utils');
+const { filterSafeTags, patchType } = require('../../common');
+
+const ruleId = 'unvalidated-redirect';
 
 module.exports = function (core) {
   const {
     depHooks,
     patcher,
+    config,
     scopes: { sources },
     assess: {
       dataflow: {
         tracker,
-        sinks: { isVulnerable, reportFindings },
+        sinks: { isVulnerable, reportFindings, reportSafePositive },
         eventFactory: { createSinkEvent },
       },
     },
@@ -58,6 +61,7 @@ module.exports = function (core) {
 
   unvalidatedRedirect.install = function () {
     depHooks.resolve({ name: 'koa', file: 'lib/response', version: '<2.9.0' }, (Response) => {
+      const name = 'Koa.Response.redirect';
       patcher.patch(Response, 'redirect', {
         name: 'Koa.Response.redirect',
         patchType,
@@ -65,9 +69,10 @@ module.exports = function (core) {
           const assessStore = sources.getStore()?.assess;
           if (!assessStore) return;
 
+          let isBackRoute = false;
           let [url] = data.args;
-
           if (url === 'back') {
+            isBackRoute = true;
             url = data.obj.ctx.get('Referrer') || data.args[1];
           }
 
@@ -83,11 +88,20 @@ module.exports = function (core) {
           }
 
           if (urlPathTags && isVulnerable(UNTRUSTED, safeTags, urlPathTags)) {
+            const args = [];
+            if (isBackRoute) {
+              args.push({
+                tracked: false,
+                value: data.args[0]
+              });
+            }
+            args.push({
+              tracked: true,
+              value: strInfo.value,
+            });
+
             const event = createSinkEvent({
-              args: [{
-                tracked: true,
-                value: strInfo.value,
-              }],
+              args,
               context: `response.redirect(${inspect(strInfo.value)})`,
               history: [strInfo],
               name: 'Koa.Response.redirect',
@@ -100,7 +114,7 @@ module.exports = function (core) {
                 value: undefined,
               },
               tags: urlPathTags,
-              source: 'P0',
+              source: `P${isBackRoute ? 1 : 0}`,
               stacktraceOpts: {
                 constructorOpt: data.hooked,
               },
@@ -108,10 +122,20 @@ module.exports = function (core) {
 
             if (event) {
               reportFindings({
-                ruleId: 'unvalidated-redirect',
+                ruleId,
                 sinkEvent: event,
               });
             }
+          } else if (config.assess.safe_positives.enable) {
+            reportSafePositive({
+              name,
+              ruleId,
+              safeTags: filterSafeTags(safeTags, strInfo),
+              strInfo: {
+                tags: strInfo.tags,
+                value: strInfo.value,
+              }
+            });
           }
         }
       });