@contrast/assess 1.11.0 → 1.13.0

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright: 2023 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.

package/lib/dataflow/index.js

@@ -20,7 +20,6 @@ const { callChildComponentMethodsSync } = require('@contrast/common');
 module.exports = function(core) {
   const dataflow = core.assess.dataflow = {};
 
-  require('./event-factory')(core);
   require('./tracker')(core);
   require('./sources')(core);
   require('./propagation')(core);

package/lib/dataflow/propagation/index.js

@@ -45,6 +45,8 @@ module.exports = function(core) {
   require('./install/JSON')(core);
   require('./install/path')(core);
   require('./install/reg-exp-prototype-exec')(core);
+  require('./install/joi')(core);
+  require('./install/send')(core);
 
   propagation.install = function() {
     callChildComponentMethodsSync(propagation, 'install');

package/lib/dataflow/propagation/install/JSON/parse.js

@@ -52,10 +52,8 @@ module.exports = function (core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      dataflow: {
-        tracker,
-        eventFactory: { createPropagationEvent },
-      },
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker },
     },
   } = core;
 

package/lib/dataflow/propagation/install/JSON/stringify.js

@@ -76,7 +76,8 @@ module.exports = function(core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/array-prototype-join.js

@@ -26,7 +26,8 @@ module.exports = function(core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/buffer.js

@@ -19,10 +19,8 @@ const { patchType } = require('../common');
 module.exports = function(core) {
   const {
     assess: {
-      dataflow: {
-        eventFactory,
-        tracker
-      }
+      eventFactory,
+      dataflow: { tracker }
     },
     patcher,
   } = core;

package/lib/dataflow/propagation/install/contrast-methods/add.js

@@ -26,7 +26,8 @@ module.exports = function(core) {
     scopes: { instrumentation, sources },
     patcher,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/contrast-methods/string.js

@@ -32,10 +32,8 @@ module.exports = function(core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      dataflow: {
-        tracker,
-        eventFactory: { createPropagationEvent },
-      },
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker },
     }
   } = core;
 

package/lib/dataflow/propagation/install/contrast-methods/tag.js

@@ -20,10 +20,8 @@ const { patchType } = require('../../common');
 module.exports = function(core) {
   const {
     assess: {
-      dataflow: {
-        tracker,
-        eventFactory: { createPropagationEvent },
-      },
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker },
     },
     patcher,
     scopes: { sources, instrumentation },

package/lib/dataflow/propagation/install/decode-uri-component.js

@@ -28,7 +28,8 @@ module.exports = function(core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/ejs/escape-xml.js

@@ -29,7 +29,8 @@ module.exports = function(core) {
     patcher,
     depHooks,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/encode-uri-component.js

@@ -28,7 +28,8 @@ module.exports = function(core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/escape-html.js

@@ -29,7 +29,8 @@ module.exports = function(core) {
     patcher,
     depHooks,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/escape.js

@@ -28,7 +28,8 @@ module.exports = function(core) {
     scopes: { sources, instrumentation },
     patcher,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

package/lib/dataflow/propagation/install/handlebars-utils-escape-expression.js

@@ -29,7 +29,8 @@ module.exports = function(core) {
     patcher,
     depHooks,
     assess: {
-      dataflow: { tracker, eventFactory: { createPropagationEvent } }
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker }
     }
   } = core;
 

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

@@ -0,0 +1,35 @@
+/*
+ * Copyright: 2023 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 { callChildComponentMethodsSync } = require('@contrast/common');
+
+module.exports = function(core) {
+  const joiInstrumentation = core.assess.dataflow.propagation.joiInstrumentation = {
+    install() {
+      callChildComponentMethodsSync(joiInstrumentation, 'install');
+    },
+    uninstall() {
+      callChildComponentMethodsSync(joiInstrumentation, 'uninstall');
+    },
+  };
+
+  require('./keys')(core);
+  require('./string-schema')(core);
+  require('./values')(core);
+
+  return joiInstrumentation;
+};

package/lib/dataflow/propagation/install/joi/keys.js

@@ -0,0 +1,140 @@
+/*
+ * Copyright: 2023 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 {
+  isNonEmptyObject, join,
+} = require('@contrast/common');
+const { patchType } = require('../../common');
+
+module.exports = function(core) {
+  const {
+    depHooks,
+    patcher,
+  } = core;
+
+  function addMetadata(schema, refTargetPath, refPath, isInReference) {
+    if (!schema.__CONTRAST__) {
+      Object.defineProperty(schema, '__CONTRAST__', {
+        enumerable: false,
+        configurable: true,
+        value: {
+          inReferenceTargets: new Set(),
+          refTargets: {}
+        },
+        writable: true,
+      });
+    }
+
+    let path = join(refTargetPath, '.');
+
+    if (isInReference) {
+      path = join(refTargetPath.slice(0, -1), '.');
+      schema.__CONTRAST__.inReferenceTargets.add(path);
+      refPath = refPath.slice(0, -1);
+    }
+
+    const refs = schema.__CONTRAST__.refTargets[path] || [];
+    refs.push(join(refPath, '.'));
+    schema.__CONTRAST__.refTargets[path] = refs;
+  }
+
+  function traverseChildSchemas(schema, refTargetPath, currentPath, refOpts) {
+    const traversable = schema.type === 'object' ? schema._ids._byKey.entries() : Object.entries(schema.$_terms.items);
+
+    for (const [childKey, item] of traversable) {
+      const value = schema.type === 'object' ? item.schema : item;
+      const newRefTargetPath = [...refTargetPath, childKey];
+      const newCurrentPath = [...currentPath, childKey];
+
+      if (value.type === 'string') {
+        addMetadata(value, newRefTargetPath, newCurrentPath, refOpts.in);
+      } else if (value.type === 'object') {
+        traverseChildSchemas(value, newRefTargetPath, newCurrentPath, refOpts);
+      }
+    }
+  }
+
+  function traverseSchemas(
+    joi,
+    currentSchema,
+    obj,
+    ancestorRef = [],
+    currentPath = [],
+  ) {
+    ancestorRef.unshift(obj);
+    if (joi.isSchema(currentSchema) || joi.isExpression(currentSchema)) return;
+    if (currentSchema && joi.isRef(currentSchema) && !currentSchema.__CONTRAST__?.isVisited) {
+      const targetSchemaRef = currentSchema.path.reduce((acc, value) => {
+        let ret = acc?.[value] || acc;
+
+        if (joi.isSchema(acc)) {
+          ret = acc?.$_terms?.keys.find(i => i.key === value);
+        }
+
+        return ret;
+      }, ancestorRef[currentSchema.ancestor - 1]);
+
+      const refTargetPath = currentSchema.absolute({ path: currentPath });
+      const targetSchemaInstace =
+        typeof targetSchemaRef?.schema === 'object'
+          ? targetSchemaRef.schema
+          : targetSchemaRef;
+
+      if (!targetSchemaInstace) return;
+
+      if (['object', 'array'].includes(targetSchemaInstace.type)) {
+        traverseChildSchemas(targetSchemaInstace, refTargetPath, currentPath, currentSchema);
+      } else {
+        addMetadata(targetSchemaInstace, refTargetPath, currentPath);
+      }
+      Object.defineProperty(currentSchema, '__CONTRAST__', {
+        enumerable: false,
+        configurable: true,
+        value: {
+          isVisited: true,
+        },
+        writable: true
+      });
+    } else {
+      if (isNonEmptyObject(currentSchema)) {
+        for (const [objKey, objValue] of Object.entries(currentSchema)) {
+          traverseSchemas(joi, objValue, currentSchema, ancestorRef, [...currentPath, objKey]);
+        }
+      }
+    }
+  }
+
+  return (core.assess.dataflow.propagation.joiInstrumentation.keys = {
+    install() {
+      depHooks.resolve(
+        { name: 'joi', file: 'lib/types/keys.js', version: '>=17.0.0' },
+        (joi) => {
+          patcher.patch(Object.getPrototypeOf(joi), 'keys', {
+            name: 'joi.keys',
+            patchType,
+            pre(data) {
+              const [value] = data.args;
+              const joi = data.obj.$_root;
+
+              traverseSchemas(joi, value, value);
+            },
+          });
+        }
+      );
+    },
+  });
+};

package/lib/dataflow/propagation/install/joi/string-schema.js

@@ -0,0 +1,269 @@
+/*
+ * Copyright: 2023 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 {
+  DataflowTag: { ALPHANUM_SPACE_HYPHEN, LIMITED_CHARS, STRING_TYPE_CHECKED },
+  inspect,
+  join,
+  split,
+} = require('@contrast/common');
+const { createFullLengthCopyTags } = require('../../../tag-utils');
+const { patchType } = require('../../common');
+const VALIDATORS = {
+  base64: ALPHANUM_SPACE_HYPHEN,
+  guid: ALPHANUM_SPACE_HYPHEN,
+  alphanum: ALPHANUM_SPACE_HYPHEN,
+  hex: ALPHANUM_SPACE_HYPHEN,
+  isoDate: ALPHANUM_SPACE_HYPHEN,
+  isoDuration: ALPHANUM_SPACE_HYPHEN,
+  token: ALPHANUM_SPACE_HYPHEN,
+  creditCard: LIMITED_CHARS,
+  ip: LIMITED_CHARS,
+  hostname: ALPHANUM_SPACE_HYPHEN,
+  domain: ALPHANUM_SPACE_HYPHEN,
+};
+
+module.exports = function(core) {
+  const {
+    depHooks,
+    scopes: { sources, instrumentation },
+    patcher,
+    assess: {
+      eventFactory: { createPropagationEvent },
+      dataflow: { tracker },
+    },
+  } = core;
+
+  function definePropagation(methodName, tagName, inspectedSchema, origFn) {
+    function propagationFn(strInfo) {
+      const event = createPropagationEvent({
+        addedTags: [tagName],
+        name: `Joi.string.${methodName}`,
+        moduleName: 'joi',
+        methodName: `string.${methodName}`,
+        history: [{ ...strInfo }],
+        object: {
+          tracked: false,
+          value: 'Joi.string',
+        },
+        args: [
+          { tracked: true, value: strInfo.value },
+          { tracked: false, value: inspectedSchema },
+        ],
+        result: {
+          tracked: false,
+          value: undefined,
+        },
+        source: 'P0',
+        tags: {
+          ...strInfo.tags,
+          [tagName]: [0, strInfo.value.length - 1],
+        },
+        target: 'P0',
+        stacktraceOpts: {
+          prependFrames: [origFn],
+        },
+      });
+
+      if (event) {
+        Object.assign(strInfo, event);
+      }
+    }
+
+    Object.defineProperty(propagationFn, 'name', {
+      value: tagName,
+      writable: false,
+    });
+
+    return propagationFn;
+  }
+
+  function getRefInstancesTrackingData(obj, refInstancesPaths) {
+    return refInstancesPaths
+      .map((referenceInstance) => {
+        const value = split(referenceInstance, '.').reduce(
+          (acc, v) => acc[v] || acc,
+          obj
+        );
+        return tracker.getData(value);
+      })
+      .filter(Boolean);
+  }
+
+  function patchValidator(
+    validatorObj,
+    patchName,
+    validatorName,
+    tagName,
+  ) {
+    patcher.patch(validatorObj, 'validate', {
+      name: patchName,
+      patchType,
+      post(data) {
+        const [input, schema] = data.args;
+
+        if (
+          !input ||
+          (validatorName !== 'validate' && typeof data.result !== 'string') ||
+          (validatorName === 'validate' && data.result) ||
+          !sources.getStore()?.assess ||
+          instrumentation.isLocked()
+        )
+          return;
+
+        const contrastData = schema?.schema?.__CONTRAST__;
+        let refTargetPath = join(schema.state.path, '.');
+        const inReferenceTargetPath = join(schema.state.path.slice(0, -1), '.');
+        if (contrastData?.inReferenceTargets.has(inReferenceTargetPath)) {
+          refTargetPath = join(
+            schema.state.path.slice(0, -1),
+            '.'
+          );
+        }
+        const references = contrastData?.refTargets[refTargetPath];
+
+        const strInfo = tracker.getData(input);
+
+        const inspectedSchema = inspect(schema);
+        const validation = definePropagation(
+          validatorName,
+          tagName,
+          inspectedSchema,
+          data.orig
+        );
+        if (references?.length) {
+          getRefInstancesTrackingData(
+            schema.state.ancestors[schema.state.ancestors.length - 1],
+            references
+          ).forEach((refMetadata) => {
+            let { eventualValidations } = refMetadata;
+            if (!eventualValidations) {
+              eventualValidations = { [refTargetPath]: [validation] };
+            } else if (!eventualValidations[refTargetPath]) {
+              eventualValidations[refTargetPath] = [validation];
+            } else if (
+              !eventualValidations[refTargetPath].find(
+                (v) => v.name === tagName
+              )
+            ) {
+              eventualValidations[refTargetPath].push(validation);
+            }
+
+            refMetadata.eventualValidations = eventualValidations;
+          });
+        }
+
+        if (strInfo) {
+          validation(strInfo);
+        }
+      },
+    });
+  }
+
+  function reTrackCoercedValue(coerce) {
+    patcher.patch(coerce, 'method', {
+      name: 'joi.string._definition.coerce',
+      patchType,
+      post(data) {
+        const { args, result } = data;
+
+        if (
+          !args[0] ||
+          // currently, we are losing track of coerced isoDate only
+          !args[1].schema.$_getRule('isoDate') ||
+          !sources.getStore()?.assess ||
+          instrumentation.isLocked()
+        )
+          return;
+
+        const argInfo = tracker.getData(args[0]);
+
+        if (!argInfo) {
+          return;
+        }
+
+        const event = createPropagationEvent({
+          name: 'Joi.string.isoDate.coerce',
+          moduleName: 'joi',
+          methodName: 'string.isDate.coerce',
+          history: [argInfo],
+          object: {
+            tracked: false,
+            value: 'Joi.string',
+          },
+          args: [
+            { tracked: true, value: argInfo.value },
+            { tracked: false, value: inspect(args[1]) },
+          ],
+          result: {
+            tracked: false,
+            value: result,
+          },
+          source: 'P0',
+          tags: createFullLengthCopyTags(argInfo.tags, result.value.length),
+          target: 'R',
+          stacktraceOpts: {
+            prependFrames: [data.orig],
+          },
+        });
+
+        const { extern } = tracker.track(result.value, event);
+
+        if (extern) {
+          data.result.value = extern;
+        }
+      },
+    });
+  }
+
+  return (core.assess.dataflow.propagation.joiInstrumentation.stringSchema = {
+    install() {
+      depHooks.resolve(
+        { name: 'joi', file: 'lib/types/string.js', version: '>=17.0.0' },
+        (stringType) => {
+          const stringTypePrototype = Object.getPrototypeOf(stringType);
+          const definition = stringTypePrototype?._definition;
+          const rules = definition?.rules || {};
+
+          patchValidator(
+            definition,
+            'joi.string.validate',
+            'validate',
+            STRING_TYPE_CHECKED
+          );
+
+          for (const rule in VALIDATORS) {
+            if (rules[rule]) {
+              patchValidator(
+                rules[rule],
+                'joi.string._definition.rules',
+                rule,
+                VALIDATORS[rule],
+              );
+            }
+          }
+
+          const coerce = definition?.coerce;
+
+          if (coerce && rules['isoDate']) {
+            reTrackCoercedValue(coerce);
+          }
+        }
+      );
+    },
+  });
+};