@newrelic/security-agent 2.2.0 → 2.3.1

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+### v2.3.1 (2025-02-04)
+#### Bug fixes
+* Removed docker-cli-js dependency and updated mongodb unit test case (#283)
+* Added safety check for agentModule before accessing its properties (#284)
+
+### v2.3.0 (2025-02-03)
+#### Features
+* Added Support for VM module
+* IAST support for Next.js
+* Support for Insecure settings i.e crypto, hash and random modules 
+
+#### Bug fixes
+* Fix for special characters in ws header
+* Fix for getting transaction in graphql instrumentation 
+* Fix for mongodb unit tests 
+
+#### Miscellaneous chores
+* deps-dev: bump undici from v5.28.4 to v5.28.5
+* Updated axios to v1.7.9 
+
 ### v2.2.0 (2024-12-18)
 #### Features
 * Support for express 5.x 

package/THIRD_PARTY_NOTICES.md

@@ -59,7 +59,6 @@ code, the source code can be found at [https://github.com/newrelic/csec-node-age
 * [eslint-plugin-promise](#eslint-plugin-promise)
 * [eslint-plugin-sonarjs](#eslint-plugin-sonarjs)
 * [koa](#koa)
-* [mongodb-memory-server](#mongodb-memory-server)
 * [mongodb](#mongodb)
 * [mongodb](#mongodb)
 * [mongodb](#mongodb)
@@ -79,7 +78,7 @@ code, the source code can be found at [https://github.com/newrelic/csec-node-age
 
 ### axios
 
-This product includes source derived from [axios](https://github.com/axios/axios) ([v1.7.4](https://github.com/axios/axios/tree/v1.7.4)), distributed under the [MIT License](https://github.com/axios/axios/blob/v1.7.4/LICENSE):
+This product includes source derived from [axios](https://github.com/axios/axios) ([v1.7.9](https://github.com/axios/axios/tree/v1.7.9)), distributed under the [MIT License](https://github.com/axios/axios/blob/v1.7.9/LICENSE):
 
 ```
 # Copyright (c) 2014-present Matt Zabriskie & Collaborators
@@ -259,7 +258,7 @@ THE SOFTWARE.
 
 ### https-proxy-agent
 
-This product includes source derived from [https-proxy-agent](https://github.com/TooTallNate/proxy-agents) ([v7.0.4](https://github.com/TooTallNate/proxy-agents/tree/v7.0.4)), distributed under the [MIT License](https://github.com/TooTallNate/proxy-agents/blob/v7.0.4/LICENSE):
+This product includes source derived from [https-proxy-agent](https://github.com/TooTallNate/proxy-agents) ([v7.0.6](https://github.com/TooTallNate/proxy-agents/tree/v7.0.6)), distributed under the [MIT License](https://github.com/TooTallNate/proxy-agents/blob/v7.0.6/LICENSE):
 
 ```
 (The MIT License)
@@ -512,7 +511,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### semver
 
-This product includes source derived from [semver](https://github.com/npm/node-semver) ([v7.5.4](https://github.com/npm/node-semver/tree/v7.5.4)), distributed under the [ISC License](https://github.com/npm/node-semver/blob/v7.5.4/LICENSE):
+This product includes source derived from [semver](https://github.com/npm/node-semver) ([v7.6.3](https://github.com/npm/node-semver/tree/v7.6.3)), distributed under the [ISC License](https://github.com/npm/node-semver/blob/v7.6.3/LICENSE):
 
 ```
 The ISC License
@@ -1874,23 +1873,6 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ```
 
-### mongodb-memory-server
-
-This product includes source derived from [mongodb-memory-server](https://github.com/nodkz/mongodb-memory-server) ([v8.13.0](https://github.com/nodkz/mongodb-memory-server/tree/v8.13.0)), distributed under the [MIT License](https://github.com/nodkz/mongodb-memory-server/blob/v8.13.0/LICENSE.md):
-
-```
-The MIT License (MIT)
-
-Copyright (c) 2017-present Pavel Chertorogov
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-```
-
 ### mongodb
 
 This product includes source derived from [mongodb](https://github.com/mongodb/node-mongodb-native) ([v2.2.36](https://github.com/mongodb/node-mongodb-native/tree/v2.2.36)), distributed under the [Apache-2.0 License](undefined):

package/lib/instrumentation-security/hooks/crypto/nr-crypto.js

@@ -11,20 +11,24 @@ const securityMetaData = require('../../core/security-metadata');
 const { EVENT_TYPE, EVENT_CATEGORY } = require('../../core/event-constants');
 const { NR_CSEC_FUZZ_REQUEST_ID } = require('../../core/constants');
 const logger = API.getLogger();
+const NRLIB = 'newrelic/lib';
+const SALIB = 'security-agent/lib'
 
 /**
- * Entry point of ldapjs and ldapts module hook
+ * Entry point of crypto module hook
  * @param {*} shim 
  * @param {*} mod 
  * @param {*} moduleName 
  */
 function initialize(shim, mod, moduleName) {
+    if (API && API.getNRAgent() && API.getNRAgent().config.security.exclude_from_iast_scan.iast_detection_category.insecure_settings) {
+        logger.warn('insecure_settings detection is disabled');
+        return;
+    }
     logger.info('Instrumenting ' + moduleName)
     cryptoCipherHooks(shim, mod, 'createCipheriv', moduleName);
     cryptoHashHmacHooks(shim, mod, 'createHash', moduleName);
     cryptoHashHmacHooks(shim, mod, 'createHmac', moduleName);
-    // cryptoRandomHooks(shim, mod, 'randomInt', moduleName);
-    // cryptoRandomHooks(shim, mod, 'randomBytes', moduleName);
     cryptoRandomHooks(shim, Math, 'random', "Math");
 }
 /**
@@ -41,12 +45,17 @@ function cryptoCipherHooks(shim, mod, methodName, moduleName) {
             const interceptedArgs = [arguments[0]];
             shim.interceptedArgs = interceptedArgs;
             const request = requestManager.getRequest(shim);
-            if (request) {
+            if (request && API.getSecAgent() && API.getSecAgent().status && API.getSecAgent().status.getStatus() === 'active') {
                 const traceObject = secUtils.getTraceObject(shim);
                 const secMetadata = securityMetaData.getSecurityMetaData(request, interceptedArgs, traceObject, secUtils.getExecutionId(), EVENT_TYPE.CRYPTO, EVENT_CATEGORY.CIPHER)
-                const secEvent = API.generateSecEvent(secMetadata);
-                this.secEvent = secEvent;
-                API.sendEvent(secEvent);
+                if (secMetadata.traceObject && secMetadata.traceObject.stacktrace && (secMetadata.traceObject.stacktrace[0].includes(NRLIB) || secMetadata.traceObject.stacktrace[0].includes(SALIB))) {
+                    //do nothing
+                }
+                else {
+                    const secEvent = API.generateSecEvent(secMetadata);
+                    this.secEvent = secEvent;
+                    API.sendEvent(secEvent);
+                }
             }
             const result = fn.apply(this, arguments);
 
@@ -74,15 +83,21 @@ function cryptoHashHmacHooks(shim, mod, methodName, moduleName) {
             const interceptedArgs = [arguments[0]];
             shim.interceptedArgs = interceptedArgs;
             const request = requestManager.getRequest(shim);
-            if (request) {
+
+            if (request && arguments[0] !== 'sha256' && API.getSecAgent() && API.getSecAgent().status && API.getSecAgent().status.getStatus() === 'active') {
                 const traceObject = secUtils.getTraceObject(shim);
                 const secMetadata = securityMetaData.getSecurityMetaData(request, interceptedArgs, traceObject, secUtils.getExecutionId(), EVENT_TYPE.HASH, EVENT_CATEGORY.HASH)
-                const secEvent = API.generateSecEvent(secMetadata);
-                this.secEvent = secEvent;
-                API.sendEvent(secEvent);
+                if (secMetadata.traceObject && secMetadata.traceObject.stacktrace && (secMetadata.traceObject.stacktrace[0].includes(NRLIB) || secMetadata.traceObject.stacktrace[0].includes(SALIB))) {
+                    //do nothing
+                }
+                else {
+                    const secEvent = API.generateSecEvent(secMetadata);
+                    this.secEvent = secEvent;
+                    API.sendEvent(secEvent);
+                }
             }
             const result = fn.apply(this, arguments);
-            if (result && request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]) {
+            if (result && request && request.headers[NR_CSEC_FUZZ_REQUEST_ID] && arguments[0] !== 'sha256') {
                 API.generateExitEvent(this.secEvent);
                 delete this.secEvent
             }
@@ -104,12 +119,18 @@ function cryptoRandomHooks(shim, mod, methodName, moduleName) {
             const interceptedArgs = ["Math.random"];
             shim.interceptedArgs = interceptedArgs;
             const request = requestManager.getRequest(shim);
-            if (request && arguments[0]) {
+            if (request && API.getSecAgent() && API.getSecAgent().status && API.getSecAgent().status.getStatus() === 'active') {
                 const traceObject = secUtils.getTraceObject(shim);
                 const secMetadata = securityMetaData.getSecurityMetaData(request, interceptedArgs, traceObject, secUtils.getExecutionId(), EVENT_TYPE.RANDOM, EVENT_CATEGORY.WEAKRANDOM)
-                const secEvent = API.generateSecEvent(secMetadata);
-                this.secEvent = secEvent;
-                API.sendEvent(secEvent);
+                if (secMetadata.traceObject && secMetadata.traceObject.stacktrace && secMetadata.traceObject.stacktrace[0] && (secMetadata.traceObject.stacktrace[0].includes(NRLIB) || secMetadata.traceObject.stacktrace[0].includes(SALIB))) {
+                    //do nothing
+                }
+                else {
+                    const secEvent = API.generateSecEvent(secMetadata);
+                    this.secEvent = secEvent;
+                    API.sendEvent(secEvent);
+                }
+
             }
             const result = fn.apply(this, arguments);
             if (result && request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]) {

package/lib/instrumentation-security/hooks/graphql/nr-graphql.js

@@ -27,10 +27,10 @@ module.exports = function initialize(shim, mod) {
       return fn;
     }
     return function wrappedExecute() {
-      const segment = shim.getActiveSegment();
+      const transaction = shim.tracer.getTransaction();
       try {
-        if (segment && segment.transaction) {
-          let request = requestManager.getRequestFromId(segment.transaction.id);
+        if (transaction) {
+          let request = requestManager.getRequestFromId(transaction.id);
           let customDataType = {};
           //check for query parms
           if (request.headers['x-apollo-operation-name']) {
@@ -47,7 +47,7 @@ module.exports = function initialize(shim, mod) {
               }
             }
             request.customDataType = customDataType;
-            requestManager.setRequest(segment.transaction.id, request);
+            requestManager.setRequest(transaction.id, request);
           }
 
           //check for body
@@ -60,7 +60,7 @@ module.exports = function initialize(shim, mod) {
               customDataType['*.variables'] = 'GRAPHQL_VARIABLE';
             }
             request.customDataType = customDataType;
-            requestManager.setRequest(segment.transaction.id, request);
+            requestManager.setRequest(transaction.id, request);
           }
         }
 

package/lib/instrumentation-security/hooks/http/nr-http.js

@@ -459,8 +459,8 @@ function responseHook(resp, req, shim) {
       const policy = API.getPolicy();
       const dynamicScanningFlag = policy.data ? (policy.data.vulnerabilityScan?.enabled && policy.data.vulnerabilityScan.iastScan.enabled) : false;
       const type = response.getHeader(CONTENT_TYPE);
-      let isUnsupportedType = isUnsupportedContentType(type);
-
+      let isUnsupportedType = isUnsupportedContentType(type, response);
+      
       if (request && (construct || dynamicScanningFlag) && !isUnsupportedType) {
         const args = [];
         args.push(construct);
@@ -481,8 +481,11 @@ function responseHook(resp, req, shim) {
  * @param {*} conType 
  * @returns 
  */
-function isUnsupportedContentType(conType) {
+function isUnsupportedContentType(conType, response) {
   try {
+    if(response.getHeaders()['etag']){
+      return false;
+    }
     if (!conType) {
       return true;
     }
@@ -534,7 +537,7 @@ function isUnsupportedContentType(conType) {
 function responseBodyCompute(response, args) {
   let encoding = UTF8;
   const type = response.getHeader(CONTENT_TYPE);
-  let isUnsupportedType = isUnsupportedContentType(type);
+  let isUnsupportedType = isUnsupportedContentType(type, response);
   if (isUnsupportedType) {
     return;
   }

package/lib/instrumentation-security/hooks/native/nr-vm.js

@@ -0,0 +1,46 @@
+module.exports = initialize;
+const requestManager = require("../../core/request-manager");
+const secUtils = require("../../core/sec-utils");
+const API = require("../../../nr-security-api");
+const securityMetaData = require('../../core/security-metadata');
+const { NR_CSEC_FUZZ_REQUEST_ID } = require('../../core/constants');
+const logger = API.getLogger();
+
+function initialize(shim, vm, moduleName) {
+  logger.info('Instrumenting', moduleName);
+  vmHooks(shim, vm, 'runInNewContext', moduleName);
+  vmHooks(shim, vm, 'runInThisContext', moduleName);
+  vmHooks(shim, vm, 'runInContext', moduleName);
+}
+
+/**
+ * Wrapper to hook vm methods
+ * @param {*} shim 
+ * @param {*} vm 
+ * @param {*} method 
+ * @param {*} moduleName 
+ */
+function vmHooks(shim, vm, method, moduleName) {
+  shim.wrap(vm, method, function makeWrapper(shim, fn) {
+    logger.debug(`Instrumenting ${moduleName}.${method}`);
+    return function wrapper() {
+      const interceptedArgs = [arguments[0]];
+      shim.interceptedArgs = interceptedArgs;
+      const request = requestManager.getRequest(shim);
+      if (request) {
+        const traceObject = secUtils.getTraceObject(shim);
+        const secMetadata = securityMetaData.getSecurityMetaData(request, interceptedArgs, traceObject, secUtils.getExecutionId(), "JAVASCRIPT_INJECTION", "JAVASCRIPT_INJECTION")
+        const secEvent = API.generateSecEvent(secMetadata);
+        this.secEvent = secEvent;
+        API.sendEvent(secEvent);
+      }
+
+      const result = fn.apply(this, arguments);
+      if (result && request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]) {
+        API.generateExitEvent(this.secEvent);
+        delete this.secEvent
+      }
+      return result;
+    };
+  });
+}

package/lib/instrumentation-security/hooks/nextjs/nr-next.js

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: New Relic Pre-Release
+ */
+
+'use strict'
+const requestManager = require("../../core/request-manager");
+const API = require("../../../nr-security-api");
+const logger = API.getLogger();
+
+const semver = require('semver')
+
+module.exports = function initialize(shim, nextjs) {
+  const nextVersion = shim.require('./package.json').version
+  logger.info("Instrumenting nextjs", nextVersion);
+
+  const nextServer = nextjs.default;
+  hookRunAPI(shim, nextServer.prototype, nextVersion);
+}
+
+/**
+ * Wrapper for Server.prototype.runApi
+ * @param {*} shim 
+ * @param {*} mod 
+ * @param {*} nextVersion 
+ */
+function hookRunAPI(shim, mod, nextVersion) {
+  shim.wrap(mod, 'runApi', function wrapRunApi(shim, originalFn) {
+    if (!shim.isFunction(originalFn)) {
+      return originalFn
+    }
+    logger.debug("Instrumenting Server.prototype.runApi");
+    return function wrappedRunApi() {
+      try {
+        const { page, params } = extractAttrs(arguments, nextVersion)
+        extractParams(shim, page, params);
+      } catch (error) {
+        logger.debug("Error while processing path paramters");
+      }
+
+      return originalFn.apply(this, arguments)
+    }
+  })
+}
+
+/**
+ * Extracts the page and params from an API request
+ *
+ * @param {object} args arguments to runApi
+ * @param {string} version next.js version
+ * @returns {object} { page, params }
+ */
+function extractAttrs(args, version) {
+  let params
+  let page
+  if (semver.gte(version, '13.4.13')) {
+    const [, , , match] = args
+    page = match?.definition?.pathname
+    params = { ...match?.params }
+  } else {
+    ;[, , , params, page] = args
+  }
+
+  return { params, page }
+}
+
+/**
+ * Utility to extract path params
+ * @param {*} page 
+ * @param {*} params 
+ */
+function extractParams(shim, page, params) {
+  try {
+    const transaction = shim.tracer.getTransaction();
+    if (transaction) {
+      let request = requestManager.getRequestFromId(transaction.id);
+      Object.keys(params).forEach(function (key) {
+        if (params[key]) {
+          if (!request.parameterMap[key]) {
+            request.parameterMap[key] = new Array(params[key].toString());
+            requestManager.setRequest(transaction.id, request);
+          }
+        }
+      });
+      if (request && page) {
+        request.uri = page;
+        requestManager.setRequest(transaction.id, request);
+      }
+    }
+  } catch (error) {
+  }
+}
+

package/lib/instrumentation-security/index.js

@@ -253,4 +253,28 @@ newrelic.instrument({
   }
 })
 
+newrelic.instrument({
+  moduleName: 'crypto',
+  onRequire: require('./hooks/crypto/nr-crypto'),
+  onError: function intrumentErrorHandler(err) {
+    logger.error(err.message, err.stack)
+  }
+})
 
+newrelic.instrumentWebframework({
+  moduleName: 'next/dist/server/next-server',
+  isEsm: true,
+  onRequire: require('./hooks/nextjs/nr-next'),
+  onError: function intrumentErrorHandler(err) {
+    logger.error(err.message, err.stack)
+  }
+})
+
+newrelic.instrument({
+  moduleName: 'vm',
+  isEsm: true,
+  onRequire: require('./hooks/native/nr-vm'),
+  onError: function intrumentErrorHandler(err) {
+    logger.error(err.message, err.stack)
+  }
+})

package/lib/nr-security-agent/lib/core/Auth-headers.js

@@ -36,7 +36,8 @@ function AuthHeaders() {
         authHeaders['NR-ACCOUNT-ID'] = NRAgent.config.account_id;
         authHeaders['NR-LICENSE-KEY'] = NRAgent ? NRAgent.config.license_key : '';
         authHeaders["NR-CSEC-IAST-DATA-TRANSFER-MODE"] = "PULL";
-        authHeaders['NR-CSEC-ENTITY-NAME'] = metadata['entity.name'] ? metadata['entity.name'] : '';
+        const entityName = metadata['entity.name'] ? metadata['entity.name'] : '';
+        authHeaders['NR-CSEC-ENTITY-NAME'] = encodeURIComponent(entityName);
         authHeaders['NR-CSEC-ENTITY-GUID'] = metadata['entity.guid'] ? metadata['entity.guid'] : '';
         let instanceCount = parseInt(NRAgent.config.security.scan_controllers.scan_instance_count);
         if (isNaN(instanceCount)) {

package/lib/nr-security-agent/lib/core/event.js

@@ -12,6 +12,7 @@ const API = require('../../../nr-security-api');
 const NRAgent = API.getNRAgent();
 const lodash = require('lodash');
 const commonUtils = require('./commonUtils');
+const crypto = require('crypto');
 /**
 * BasicInfo Structure, which is applicatble to each
 * Event generated from agent.
@@ -99,7 +100,7 @@ function SecEvent(fileName, funcName, lineNumber, argument, eid, applicationInfo
     const dynamicScanning = vulnerabilityScan.enabled && vulnerabilityScan.iastScan.enabled;
     this.isIASTEnable = dynamicScanning;
     if (this.isIASTEnable) {
-        this.id = eid + Math.floor(Math.random() * (100000 - 1) + 1);
+        this.id = eid + Math.floor(crypto.randomInt(100) * (100000 - 1) + 1);
     } else {
         this.id = eid;
     }

package/lib/nr-security-agent/lib/core/sec-util.js

@@ -196,7 +196,7 @@ function generateExitEvent(secEvent) {
 
 function sendEvent(secEvent) {
     const agentModule = Agent.getAgent();
-    if (agentModule.status.getStatus() != 'connecting' && NRAgent.config.security.enabled && agentModule.status.getStatus() == 'active') {
+    if (agentModule && agentModule.status.getStatus() != 'connecting' && NRAgent.config.security.enabled && agentModule.status.getStatus() == 'active') {
         agentModule.client.dispatcher(secEvent);
         if (!firstEventSent && agentModule.status.getStatus() === 'active') {
             if(commonUtils.trafficStartedTime == 0){

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "New Relic Security Agent for Node.js",
   "main": "index.js",
   "jsonVersion": "1.2.9",
@@ -39,7 +39,7 @@
     "url": "https://github.com/newrelic/csec-node-agent.git"
   },
   "dependencies": {
-    "axios": "^1.7.4",
+    "axios": "^1.7.9",
     "check-disk-space": "^3.4.0",
     "content-type": "^1.0.5",
     "cron": "^3.1.7",
@@ -84,7 +84,6 @@
     "eslint-plugin-sonarjs": "^0.15.0",
     "koa": "^2.14.1",
     "mongodb": "^4.13.0",
-    "mongodb-memory-server": "^8.11.2",
     "mongodb2": "npm:mongodb@^2.2.36",
     "mongodb3": "npm:mongodb@^3.7.3",
     "newrelic": "^10.3.1",