@newrelic/security-agent 1.0.1 → 1.1.1

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+### v1.1.1 (2024-03-21)
+#### Bug fixes
+* Reverted IAST support for gRPC.
+
+### v1.1.0 (2024-03-19)
+#### Features
+* IAST support for grpc 
+* Functionality to report API endpoints of the application
+* IAST support for undici
+#### Bug fixes
+* Updated permissions for file/directory created by security agent
+#### Miscellaneous chores
+* Bumped follow-redirects from v1.15.2 to v1.15.4  
+* Updated axios to v1.6.8
+* Bumped ip from v2.0.0 to v2.0.1
+* Bumped undici from 5.28.2 to v5.28.3
+* Readme update
+
 ### v1.0.1 (2024-02-07)
 #### Bug fixes
 * Reporting of framework in security event json 

package/README.md

@@ -3,7 +3,7 @@
 
 **Note**: The IAST capability should only be used in pre-production environments as the application is tested for real exploitable vulnerabilities.
 
-The New Relic security agent is in preview and is not generally available. This module enables instrumentation of a Node.js application for interactive application security testing(IAST) and exposes exploitable vulnerabilities. 
+The New Relic security agent enables instrumentation of a Node.js application for Interactive Application Security Testing(IAST) and exposes exploitable vulnerabilities. 
 
 ## Installation
 
@@ -67,6 +67,7 @@ The [Developer docs](http://newrelic.github.io/node-newrelic/) for writing instr
 - [ldapts](https://www.npmjs.com/package/ldapts)(2.x and above)
 - [xpath](https://www.npmjs.com/package/xpath)(0.0.20 and above)
 - [xpath.js](https://www.npmjs.com/package/xpath.js)(0.0.1 and above) 
+- [undici](https://www.npmjs.com/package/undici)(4.7.0 and above) 
 
 For more information, please see New Relic Node.js agent [compatibility and requirements](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent/).
 

package/THIRD_PARTY_NOTICES.md

@@ -64,7 +64,9 @@ code, the source code can be found at [https://github.com/newrelic/csec-node-age
 * [request](#request)
 * [restify](#restify)
 * [sinon](#sinon)
+* [stream](#stream)
 * [tap](#tap)
+* [undici](#undici)
 * [xmldom](#xmldom)
 * [xpath.js](#xpathjs)
 * [xpath](#xpath)
@@ -74,7 +76,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.6.5](https://github.com/axios/axios/tree/v1.6.5)), distributed under the [MIT License](https://github.com/axios/axios/blob/v1.6.5/LICENSE):
+This product includes source derived from [axios](https://github.com/axios/axios) ([v1.6.8](https://github.com/axios/axios/tree/v1.6.8)), distributed under the [MIT License](https://github.com/axios/axios/blob/v1.6.8/LICENSE):
 
 ```
 # Copyright (c) 2014-present Matt Zabriskie & Collaborators
@@ -2588,6 +2590,22 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ```
 
+### stream
+
+This product includes source derived from [stream](https://github.com/juliangruber/stream) ([v0.0.2](https://github.com/juliangruber/stream/tree/v0.0.2)), distributed under the [MIT License](https://github.com/juliangruber/stream/blob/v0.0.2/README.md):
+
+```
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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.
+```
+
 ### tap
 
 This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v16.3.7](https://github.com/tapjs/node-tap/tree/v16.3.7)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v16.3.7/LICENSE):
@@ -2611,6 +2629,35 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ```
 
+### undici
+
+This product includes source derived from [undici](https://github.com/nodejs/undici) ([v5.28.3](https://github.com/nodejs/undici/tree/v5.28.3)), distributed under the [MIT License](https://github.com/nodejs/undici/blob/v5.28.3/LICENSE):
+
+```
+MIT License
+
+Copyright (c) Matteo Collina and Undici contributors
+
+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.
+
+```
+
 ### xmldom
 
 This product includes source derived from [xmldom](https://github.com/xmldom/xmldom) ([v0.6.0](https://github.com/xmldom/xmldom/tree/v0.6.0)), distributed under the [MIT License](https://github.com/xmldom/xmldom/blob/v0.6.0/LICENSE):

package/lib/instrumentation-security/core/route-manager.js

@@ -10,8 +10,8 @@ const routeMap = new Map();
  * @param {*} key 
  * @param {*} value 
  */
-function setRoute(key, value){
-    routeMap.set(key,value);
+function setRoute(key, value) {
+    routeMap.set(key, value);
 }
 
 /**
@@ -19,12 +19,35 @@ function setRoute(key, value){
  * @param {*} key 
  * @returns 
  */
-function getRoute(key){
+function getRoute(key) {
     return routeMap.get(key);
 }
 
-module.exports={
+/**
+ * Utility to get all api end points
+ * @returns all keys from routeMap
+ */
+function getAllAPIEndPoints() {
+    let apiEndpoints = [];
+    try {
+        routeMap.forEach((value, key) => {
+            let obj = {};
+            let splitted = key.split('@');
+            obj.method = splitted[0];
+            obj.path = splitted[1];
+            obj.handler = routeMap.get(key);
+            apiEndpoints.push(obj);
+        })
+    } catch (error) {
+
+    }
+
+    return apiEndpoints;
+}
+
+module.exports = {
     getRoute,
     setRoute,
-    routeMap
+    routeMap,
+    getAllAPIEndPoints
 }

package/lib/instrumentation-security/core/sec-utils.js

@@ -150,11 +150,11 @@ function getExecutionId(){
 function createPathIfNotExist (dir) {
     try {
         if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir, 777, { recursive: true });
+            fs.mkdirSync(dir, 770, { recursive: true });
             logger.info(dir + ' Created');
-            fs.chmodSync(dir, 0o777);
+            fs.chmodSync(dir, 0o770);
         } else {
-            fs.chmodSync(dir, 0o777);
+            fs.chmodSync(dir, 0o770);
             logger.debug(dir + ' Already Exists');
         }
     } catch (error) {

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

@@ -27,9 +27,8 @@ module.exports = function initialize(shim, express, moduleName) {
 
   if (express.Router.use) {
     wrapExpress4(shim, express)
-  } else {
-    // wrapExpress3(shim, express)
-  }
+  } 
+ 
 }
 
 /**
@@ -57,7 +56,6 @@ function wrapExpress4(shim, express) {
     }
   })
 
-
   //Wrapper to hook process_params method to extract out path param and query params.
   shim.wrap(express.Router, 'process_params', function wrapParam(shim, fn) {
     if (!shim.isFunction(fn)) {

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

@@ -0,0 +1,139 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: New Relic Pre-Release
+ */
+
+module.exports = initialize
+const requestManager = require('../../core/request-manager');
+const secUtils = require("../../core/sec-utils");
+const API = require("../../../nr-security-api");
+const lodash = require('lodash');
+const securityMetaData = require('../../core/security-metadata');
+const { EVENT_TYPE, EVENT_CATEGORY } = require('../../core/event-constants');
+const { NR_CSEC_FUZZ_REQUEST_ID, QUESTION_MARK, EMPTY_STRING, COLON, SLASH } = require('../../core/constants');
+const NRCSECTRACINGDATA = 'NR-CSEC-TRACING-DATA';
+const DOUBLE_SLASH = '//';
+const logger = API.getLogger();
+const url = require('url');
+
+
+/**
+ * Entry point undici module instrumentation.
+ * @param {*} shim 
+ * @param {*} mod 
+ * @param {*} moduleName 
+ */
+function initialize(shim, mod, moduleName) {
+  logger.info('Instrumenting ' + moduleName);
+  fetchHook(shim, mod, "fetch");
+  let util = shim.require('./lib/core/util');
+  parseOriginHook(shim, util, "parseOrigin")
+
+}
+/**
+ * Wrapper for util.parseOrigin
+ * @param {*} shim 
+ * @param {*} mod 
+ * @param {*} methodName 
+ */
+function parseOriginHook(shim, mod, methodName) {
+  shim.wrap(mod, methodName, function ClientWrapper(shim, fn) {
+    logger.debug(`Instrumenting ${methodName}`);
+    if (!shim.isFunction(fn)) {
+      return fn
+    }
+    return function wrapper() {
+      const request = requestManager.getRequest(shim);
+      try {
+        if (typeof arguments[0] === 'string') {
+          let URLObject = new URL(arguments[0]);
+          const data = {};
+          data.headers = {};
+          data.path = URLObject.pathname ? URLObject.pathname : EMPTY_STRING;
+          data.protocol = URLObject.protocol ? URLObject.protocol : 'http:';
+          data.headers.host = URLObject.host ? URLObject.host : URLObject.hostname;
+          shim.interceptedArgs = data;
+          if (request) {
+            const traceObject = secUtils.getTraceObject(shim);
+            const secMetadata = securityMetaData.getSecurityMetaData(request, data, traceObject, secUtils.getExecutionId(), EVENT_TYPE.HTTP_REQUEST, EVENT_CATEGORY.HTTP)
+            this.secEvent = API.generateSecEvent(secMetadata);
+            API.sendEvent(this.secEvent);
+          }
+        }
+      } catch (error) {
+
+      }
+      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;
+    }
+  })
+}
+
+/**
+ * Wrapper to hook undici.fetch()
+ * @param {*} shim 
+ * @param {*} mod 
+ * @param {*} methodName 
+ */
+function fetchHook(shim, mod, methodName) {
+  shim.wrap(mod, methodName, function makeWrapper(shim, fn) {
+    logger.debug(`Instrumenting ${methodName}`);
+    if (!shim.isFunction(fn)) {
+      return fn
+    }
+    return function wrapper() {
+      const request = requestManager.getRequest(shim);
+      try {
+        const completeURL = arguments[0];
+        const parsedUrl = url.parse(completeURL);
+        const data = {};
+        data.headers = {};
+        data.method = arguments[0].method ? arguments[0].method : EMPTY_STRING;
+        data.path = parsedUrl.pathname ? parsedUrl.pathname : parsedUrl.path;
+        data.protocol = parsedUrl.protocol;
+        data.headers.host = parsedUrl.host ? parsedUrl.host : parsedUrl.hostname;
+        data.port = parsedUrl.port ? parsedUrl.port : parsedUrl.port;
+
+        shim.interceptedArgs = data;
+        if (request && !lodash.isEmpty(data.headers.host) && !lodash.isEmpty(data.path)) {
+          const appUUID = API.getSecAgent().applicationInfo.applicationUUID;
+          const traceObject = secUtils.getTraceObject(shim);
+          const secMetadata = securityMetaData.getSecurityMetaData(request, data, traceObject, secUtils.getExecutionId(), EVENT_TYPE.HTTP_REQUEST, EVENT_CATEGORY.HTTP)
+          this.secEvent = API.generateSecEvent(secMetadata);
+          API.sendEvent(this.secEvent);
+
+          let traceHeader = EMPTY_STRING;
+          if (request.headers['nr-csec-tracing-data']) {
+            traceHeader = request.headers['nr-csec-tracing-data'];
+          }
+
+          if (arguments[1] instanceof Object) {
+            if (arguments[1] && arguments[1].headers && request.headers) {
+              arguments[1].headers[NRCSECTRACINGDATA] = traceHeader + appUUID + '/' + this.secEvent.apiId + '/' + this.secEvent.id + ';';
+            } else {
+              arguments[1].headers = {};
+              arguments[1].headers[NRCSECTRACINGDATA] = traceHeader + appUUID + '/' + this.secEvent.apiId + '/' + this.secEvent.id + ';';
+            }
+            if (request && request.headers[NR_CSEC_FUZZ_REQUEST_ID] && arguments[1].headers) {
+              arguments[1].headers[NR_CSEC_FUZZ_REQUEST_ID] = request.headers[NR_CSEC_FUZZ_REQUEST_ID];
+            }
+          }
+        }
+      } catch (error) {
+        logger.debug("Error while extracting undici fetch args:", error);
+      }
+      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/index.js

@@ -190,6 +190,15 @@ newrelic.instrumentWebframework({
   }
 })
 
+newrelic.instrumentWebframework({
+  moduleName: 'undici',
+  isEsm: true,
+  onRequire: require('./hooks/undici/nr-undici'),
+  onError: function intrumentErrorHandler(err) {
+    logger.error(err.message, err.stack)
+  }
+})
+
 
 
 

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

@@ -0,0 +1,29 @@
+
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: New Relic Software License v1.0
+ */
+
+const { BasicInfo } = require('./event');
+const applicationInfo = require('./applicationinfo').getInstance();
+/**
+ * Function Constructor to create object of FuzzFail event
+ * @param {*} fuzzHeader
+ */
+function APIEndPoint (apiEndpoints) {
+    BasicInfo.call(this);
+    this.jsonVersion = applicationInfo.jsonVersion;
+    this.jsonName = 'sec-application-url-mapping';
+    this.eventType = "sec-application-url-mapping"
+    this.applicationUUID = applicationInfo.applicationUUID;
+    this.groupName = applicationInfo.groupName;
+    this.mappings = apiEndpoints;
+
+    return this;
+}
+
+APIEndPoint.prototype.constructor = APIEndPoint;
+
+module.exports = {
+    APIEndPoint
+};

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

@@ -97,11 +97,11 @@ function runtimeSupportsAsyncFunctionGenerators() {
 function createPathIfNotExist(dir) {
     try {
         if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir, 777, { recursive: true });
+            fs.mkdirSync(dir, 770, { recursive: true });
             logger.info(dir + ' Created');
-            fs.chmodSync(dir, 0o777);
+            fs.chmodSync(dir, 0o770);
         } else {
-            fs.chmodSync(dir, 0o777);
+            fs.chmodSync(dir, 0o770);
             logger.debug(dir + ' Already Exists');
         }
     } catch (error) {
@@ -139,7 +139,7 @@ function createDirectories() {
     createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home${SLASH}tmp${SLASH}language-agent${SLASH}${getUUID()}`);
     createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home${SLASH}tmp${SLASH}language-agent${SLASH}${getUUID()}${SLASH}ds-tmp`);
     try {
-        fs.chmodSync(`${CSEC_HOME}${SLASH}nr-security-home`, 0o777);
+        fs.chmodSync(`${CSEC_HOME}${SLASH}nr-security-home`, 0o770);
     } catch (error) {
     }
 }

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

@@ -31,11 +31,11 @@ const CSEC_ROOT = `${CSEC_HOME}${sep}nr-security-home${sep}`;
 function createLogPathIfNotExist(dir) {
     try {
         if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir, 777, { recursive: true });
-            fs.chmodSync(dir, 0o777);
+            fs.mkdirSync(dir, 770, { recursive: true });
+            fs.chmodSync(dir, 0o770);
         }
         else {
-            fs.chmodSync(dir, 0o777);
+            fs.chmodSync(dir, 0o770);
         }
     } catch (error) {
     }
@@ -168,8 +168,8 @@ function getLogger(applicationUUID = process.env.applicationUUID) {
         logger = log4js.getLogger('NR_CSEC');
         const initLogger = getInitLogger();
         try {
-            fs.chmodSync(`${logFileName}`, 0o777);
-            fs.chmodSync(`${initLogFileName}`, 0o777);
+            fs.chmodSync(`${logFileName}`, 0o660);
+            fs.chmodSync(`${initLogFileName}`, 0o660);
         } catch (error) {
         }
         initLogger.info("[STEP-2] => Generating unique identifier:", applicationUUID)

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

@@ -93,7 +93,7 @@ function getFormattedData() {
 function writeSnapshot() {
     const snapshot = getFormattedData();
     commonUtils.removeOlderSnapshots();
-    fs.writeFile(statusFile, snapshot, { mode: 0o777 }, function (err) {
+    fs.writeFile(statusFile, snapshot, { mode: 0o660 }, function (err) {
         if (err) {
             logger.debug(err.message);
             const LogMessage = require('./LogMessage');
@@ -101,7 +101,7 @@ function writeSnapshot() {
             commonUtils.addLogEventtoBuffer(logMessage);
         } else {
             logger.info('Snapshot updated to file: %s', statusFile);
-            fs.chmod(statusFile, 0o777, (err) => {
+            fs.chmod(statusFile, 0o660, (err) => {
                 if (err) {
                     addErrortoBuffer(err);
                 }

package/lib/nr-security-agent/lib/core/websocket-client.js

@@ -70,6 +70,15 @@ const initialize = function () {
     setTimeout(() => {
         setInterval(sendHC, HC_INTERVAL_MS);
         sendHC();
+        try {
+            let apiEndpoints =  require('../../../instrumentation-security/core/route-manager').getAllAPIEndPoints();
+            let data  = require('./apiEndpoints').APIEndPoint(apiEndpoints);
+            logger.debug("All API end points of the application is:",JSON.stringify(data));
+            getDispatcherAndSendEvent(data);
+        } catch (error) {
+            logger.debug("Error while processing API endpoints",error);
+        }
+       
         try {
             const framework = NRAgent.environment.get('Framework')[0];
             const dispatcher = NRAgent.environment.get('Dispatcher')[0];
@@ -78,8 +87,8 @@ const initialize = function () {
         } catch (error) {
             logger.debug("Error while extracting data from APM environment",error);
         }
+    }, 20000);
 
-    }, 30000);
 
     setInterval(commonUtils.logRollOver, 30000);
     initLogger.info("[STEP-5] => Security Agent components started");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "New Relic Security Agent for Node.js",
   "main": "index.js",
   "jsonVersion": "1.1.1",
@@ -35,7 +35,7 @@
     "url": "https://github.com/newrelic/csec-node-agent.git"
   },
   "dependencies": {
-    "axios": "^1.6.5",
+    "axios": "^1.6.8",
     "check-disk-space": "^3.4.0",
     "content-type": "^1.0.5",
     "fast-safe-stringify": "^2.1.1",
@@ -84,7 +84,9 @@
     "request": "^2.88.2",
     "restify": "^11.1.0",
     "sinon": "^15.0.0",
+    "stream": "^0.0.2",
     "tap": "^16.3.2",
+    "undici": "^5.28.0",
     "xmldom": "^0.6.0",
     "xpath": "^0.0.32",
     "xpath.js": "^1.1.0"