@contrast/agent 4.15.1 → 4.16.0

package/README.md

@@ -108,4 +108,4 @@ api:
 | api.service_key | Contrast user account service key                                           |
 | api.url         | Address of the Contrast installation you would like your agent to report to |
 
-For detailed installation and configuration instructions, see the [Node.js Agent documentation](https://docs.contrastsecurity.com/installation-nodeconfig.html).
+For detailed installation and configuration instructions, see the [Node.js Agent documentation](https://docs.contrastsecurity.com/en/install-node-js.html).

package/lib/assess/sinks/dynamo.js

@@ -26,34 +26,38 @@ const disallowedTags = [
   'string-type-checked',
 ];
 const requiredTags = ['untrusted'];
-const moduleName = 'aws-sdk';
-const moduleNameV3 = '@aws-sdk/client-dynamodb';
-const relevantKeys = {
-  v2: ['ExpressionAttributeValues', 'ExclusiveStartKey', 'ScanFilter'],
-  v3: [
-    'ComparisonOperator',
-    'FilterExpression',
-    'ProjectionExpression',
-    'ScanFilter',
-  ],
-};
-const requests = new WeakSet();
 
-// map data types to methods for extracting
-// values
-const dataTypes = {
-  S: 'value',
-  N: 'value',
-  B: 'value',
-  SS: 'array',
-  NS: 'array',
-  BS: 'array',
-  M: 'object',
-  L: 'collection',
-  NULL: 'value',
-  BOOL: 'value',
+/*
+*  Schema of attributes the Node Agent is looking for user-controlled data
+*  The only exception to the rule so far is the ScanFilter in ScanCommand.
+*  It has nested schema too. So far we are only reporting a NoSQL Injection
+*  if ComparisonOperator within the ScanFilter is user-controlled.
+*  ScanFilter is handled individually in extractValues function
+* */
+const trackSchemaCommands = {
+  'scan': {
+    attributes: [
+      'ExpressionAttributeValues',
+      'ExclusiveStartKey',
+      'ScanFilter'
+    ]
+  },
+  'executeStatement': { attributes: ['Statement'] },
+  'ScanCommand': {
+    attributes: [
+      'ComparisonOperator',
+      'FilterExpression',
+      'ProjectionExpression',
+      'ScanFilter',
+    ]
+  },
+  'ExecuteStatementCommand': {
+    attributes: ['Statement']
+  }
 };
 
+const requests = new WeakSet();
+
 /**
  * Extracts all values from either a dynamo document client or client
  *
@@ -62,44 +66,25 @@ const dataTypes = {
  * @param {string} version DynamoDB SDK version
  * @return {Array} all string values from payload
  */
-function extractValues(payload = {}, mode = null, version = 'v2') {
+function extractValues(command, payload = {}) {
   return _.flatten(
-    relevantKeys[version].map((key) => {
-      if (payload[key] === undefined) return;
+    trackSchemaCommands[command].attributes.map((key) => {
+      if (payload[key] == undefined) return;
       if (typeof payload[key] === 'string') return payload[key];
+
+      // ScanFilter is an exception. It is almost safe for any nested attribute
+      if (key === 'ScanFilter') {
+        // collect the values from ComparisonOperator attributes ONLY
+        return getComparisonValues(payload[key]);
+      }
+
       const values = _.values(payload[key]);
-      const extractionMethod =
-        mode === 'client' ? findTypedValues.bind(this) : findValues.bind(this);
+      const extractionMethod = findValues.bind(this);
       return _.flattenDeep(extractionMethod(values));
     }),
   );
 }
 
-/**
- * Extracts all strings from a dynamo client payload
- * Note: Each key is typed so we need to properly extract keys based on AttributeValue types
- *
- * @param {Object} values for all keys in ExpressionAttributeValues, ExclusiveStartKey or ScanFilter
- * @return {Array} all values
- */
-function findTypedValues(values) {
-  return _.map(values, (value) => {
-    const [type] = Object.keys(value);
-    switch (dataTypes[type]) {
-      case 'value':
-        return value[type];
-      case 'array':
-        return _.values(value[type]);
-      case 'object': {
-        const values = _.values(value[type]);
-        return findTypedValues(values);
-      }
-      case 'collection':
-        return findTypedValues(value[type]);
-    }
-  });
-}
-
 /**
  * We only track strings. some data types
  * can contain strings as keys or values but
@@ -139,6 +124,27 @@ function findValues(values) {
   });
 }
 
+/**
+ * Check if key exists in ScanFilter bject and return the value if so
+ * Each element of ScanFilter is an object with predictable structure
+ * "Genre": {
+ *   "AttributeValueList":[ {"S":"Rock"} ],
+ *   "ComparisonOperator": "EQ"
+ * }
+ *
+ * @param {Object} values for all keys in a given payload
+ * @param {String} key name we are looking the value of
+ * @return {Any} if value is found for a given key
+ */
+const getComparisonValues = (obj) => Object.keys(obj).map(field => {
+  if (typeof obj[field] === 'object' && Object.prototype.hasOwnProperty.call(
+    obj[field],
+    'ComparisonOperator'
+  )) {
+    return obj[field].ComparisonOperator;
+  }
+});
+
 module.exports = ({ common }) => {
   const { isVulnerable, report } = common;
 
@@ -147,11 +153,11 @@ module.exports = ({ common }) => {
    * Registers the hooks for client and document client scan
    */
   dynamoSink.handle = function () {
-    moduleHook.resolve({ name: moduleName }, (aws) => {
+    moduleHook.resolve({ name: 'aws-sdk' }, (aws) => {
       const client = aws.DynamoDB.prototype;
 
       patcher.patch(client, 'makeRequest', {
-        name: `${moduleName}.DynamoDB.prototype`,
+        name: 'aws-sdk.DynamoDB.prototype',
         patchType: PATCH_TYPES.ASSESS_SINK,
         alwaysRun: true,
         post(data) {
@@ -163,7 +169,8 @@ module.exports = ({ common }) => {
           if (!AsyncStorage.getContext()) {
             return;
           }
-          if (data.args[0] === 'scan') {
+
+          if (Object.keys(trackSchemaCommands).includes(data.args[0]) && data.args[1]) {
             if (requests.has(data.args[1])) {
               return;
             }
@@ -176,10 +183,10 @@ module.exports = ({ common }) => {
               result: data.result,
             };
 
-            const values = extractValues(data.args[1], 'client', 'v2');
+            const values = extractValues(data.args[0], data.args[1]);
             dynamoSink.check({
               values,
-              methodName: 'DynamoDB.prototype.scan',
+              methodName: `DynamoDB.prototype.${data.args[0]}`,
               data: ctxtData,
             });
           }
@@ -198,7 +205,7 @@ module.exports = ({ common }) => {
           name: 'aws-sdk.DynamoDB.DocumentClient.prototype',
           patchType: PATCH_TYPES.ASSESS_SINK,
           pre(data) {
-            if (data.args[0] === 'scan') {
+            if (data.args[0] === 'scan' && data.args[1]) {
               requests.add(data.args[1]);
             }
           },
@@ -208,7 +215,7 @@ module.exports = ({ common }) => {
           name: 'aws-sdk.DynamoDB.DocumentClient.prototype',
           patchType: PATCH_TYPES.ASSESS_SINK,
           post(data) {
-            const values = extractValues(data.args[0], 'docClient', 'v2');
+            const values = extractValues('scan', data.args[0]);
             dynamoSink.check({
               values,
               methodName: 'DynamoDB.DocumentClient.prototype.scan',
@@ -219,27 +226,31 @@ module.exports = ({ common }) => {
       }
     });
 
-    moduleHook.resolve({ name: moduleNameV3 }, (aws) => {
+    moduleHook.resolve({ name: '@aws-sdk/client-dynamodb' }, (aws) => {
       const client = aws.DynamoDBClient.prototype;
 
       patcher.patch(client, 'send', {
-        name: `${moduleNameV3}.ScanCommand.prototype`,
+        name: '@aws-sdk/client-dynamodb.ScanCommand.prototype',
         patchType: PATCH_TYPES.ASSESS_SINK,
         alwaysRun: true,
         post(data) {
           if (!AsyncStorage.getContext()) return;
 
-          if (data.args[0] instanceof aws.ScanCommand) {
-            const values = extractValues(
-              data.args[0].input,
-              'docClient',
-              'v3',
-            ).filter(Boolean);
-            dynamoSink.check({
-              data,
-              values,
-              methodName: 'DynamoDBClient.ScanCommand',
-            });
+          if (data.args[0] && data.args[0].constructor && data.args[0].input) {
+            const sendCommand = data.args[0].constructor.name;
+
+            if (Object.keys(trackSchemaCommands).includes(sendCommand)) {
+              const values = extractValues(
+                sendCommand,
+                data.args[0].input
+              ).filter(Boolean);
+
+              dynamoSink.check({
+                data,
+                values,
+                methodName: `DynamoDBClient.${sendCommand}`,
+              });
+            }
           }
         },
       });
@@ -257,7 +268,7 @@ module.exports = ({ common }) => {
 
     if (vulnerableString.length) {
       const ctxt = new CallContext(data);
-      const signature = new Signature({ moduleName, methodName });
+      const signature = new Signature({ moduleName: 'aws-sdk', methodName });
       report({ ruleId, signature, input: vulnerableString[0], ctxt });
     }
   };

package/lib/protect/errors/handler-async-errors.js

@@ -57,7 +57,7 @@ module.exports.install = function() {
       handledErrors.add(error);
     } else {
       console.warn(
-        `An Unhandled Rejection has been caught by the Contrast Security node-agent instrumentation. Error: ${error}`,
+        'An Unhandled Rejection has been found in the instrumented code:\n%s', error
       );
     }
   }

package/lib/protect/service.js

@@ -1133,7 +1133,7 @@ class ProtectService {
    * @param   {Rule[]} rules Rules from which to build findings
    * @returns {Object[]}     The findings from the rules
    */
-  createFindings(rules, samples) {
+  createFindings(rules = [], samples) {
     const findings = [];
     const speedracer = this.reporter.speedracer &&
       this.config.agent.node.speedracer_input_analysis;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/agent",
-  "version": "4.15.1",
+  "version": "4.16.0",
   "description": "Node.js security instrumentation by Contrast Security",
   "keywords": [
     "security",
@@ -69,7 +69,7 @@
   "repository": {
     "type": "git"
   },
-  "homepage": "https://docs.contrastsecurity.com/installation-node.html#node-overview",
+  "homepage": "https://docs.contrastsecurity.com/en/install-node-js.html",
   "dependencies": {
     "@babel/generator": "^7.12.1",
     "@babel/parser": "^7.12.3",