@newrelic/security-agent 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+### v0.5.0 (2023-11-17)
+#### Features
+* IAST support for NestJS framework
+#### Bug Fixes
+* Fixed misspelled constant in fs.open() hook
+* Minor fix in applicationInfo for pod properties
+#### Miscellaneous chores
+* Upgraded ws to v8.14.2 and updated initialization of websocket for v8.x.
+* Upgraded check-disk-space to v3.4.0
+* Upgraded @aws-sdk/client-lambda to v3.436.0
+
+### v0.4.0 (2023-10-27)
+#### Features
+* Added event stats for RASP, IAST and exit events in healthcheck. 
+#### Miscellaneous chores
+* Deps: Updated uuid to v9.0.1 and @aws-sdk/client-lambda to v3.405.0
+* Upgraded axios to 1.6.0 to resolve CVE-2023-45857 
+#### Continuous integration
+* Removed Node.js 14.x from CI.
+* Added should_skip flag to skip CI based on label.
+
 ### v0.3.0 (2023-09-25)
 #### Features
 * Last leg acknowledgement in IAST scanning.

package/THIRD_PARTY_NOTICES.md

@@ -75,7 +75,7 @@ code, the source code can be found at [https://github.com/newrelic/csec-node-age
 
 ### @aws-sdk/client-lambda
 
-This product includes source derived from [@aws-sdk/client-lambda](https://github.com/aws/aws-sdk-js-v3) ([v3.379.1](https://github.com/aws/aws-sdk-js-v3/tree/v3.379.1)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.379.1/LICENSE):
+This product includes source derived from [@aws-sdk/client-lambda](https://github.com/aws/aws-sdk-js-v3) ([v3.436.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.436.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.436.0/LICENSE):
 
 ```
                                 Apache License
@@ -284,34 +284,22 @@ This product includes source derived from [@aws-sdk/client-lambda](https://githu
 
 ### axios
 
-This product includes source derived from [axios](https://github.com/axios/axios) ([v0.21.4](https://github.com/axios/axios/tree/v0.21.4)), distributed under the [MIT License](https://github.com/axios/axios/blob/v0.21.4/LICENSE):
+This product includes source derived from [axios](https://github.com/axios/axios) ([v1.6.0](https://github.com/axios/axios/tree/v1.6.0)), distributed under the [MIT License](https://github.com/axios/axios/blob/v1.6.0/LICENSE):
 
 ```
-Copyright (c) 2014-present Matt Zabriskie
+# Copyright (c) 2014-present Matt Zabriskie & Collaborators
 
-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:
+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 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.
+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.
 
 ```
 
 ### check-disk-space
 
-This product includes source derived from [check-disk-space](https://github.com/Alex-D/check-disk-space) ([v3.3.1](https://github.com/Alex-D/check-disk-space/tree/v3.3.1)), distributed under the [MIT License](https://github.com/Alex-D/check-disk-space/blob/v3.3.1/LICENSE):
+This product includes source derived from [check-disk-space](https://github.com/Alex-D/check-disk-space) ([v3.4.0](https://github.com/Alex-D/check-disk-space/tree/v3.4.0)), distributed under the [MIT License](https://github.com/Alex-D/check-disk-space/blob/v3.4.0/LICENSE):
 
 ```
 MIT License
@@ -790,7 +778,7 @@ THE SOFTWARE.
 
 ### uuid
 
-This product includes source derived from [uuid](https://github.com/uuidjs/uuid) ([v9.0.0](https://github.com/uuidjs/uuid/tree/v9.0.0)), distributed under the [MIT License](https://github.com/uuidjs/uuid/blob/v9.0.0/LICENSE.md):
+This product includes source derived from [uuid](https://github.com/uuidjs/uuid) ([v9.0.1](https://github.com/uuidjs/uuid/tree/v9.0.1)), distributed under the [MIT License](https://github.com/uuidjs/uuid/blob/v9.0.1/LICENSE.md):
 
 ```
 The MIT License (MIT)
@@ -807,30 +795,29 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### ws
 
-This product includes source derived from [ws](https://github.com/websockets/ws) ([v7.5.9](https://github.com/websockets/ws/tree/v7.5.9)), distributed under the [MIT License](https://github.com/websockets/ws/blob/v7.5.9/LICENSE):
+This product includes source derived from [ws](https://github.com/websockets/ws) ([v8.14.2](https://github.com/websockets/ws/tree/v8.14.2)), distributed under the [MIT License](https://github.com/websockets/ws/blob/v8.14.2/LICENSE):
 
 ```
-The MIT License (MIT)
-
 Copyright (c) 2011 Einar Otto Stangvik <einaros@gmail.com>
+Copyright (c) 2013 Arnout Kazemier and contributors
+Copyright (c) 2016 Luigi Pinca and 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:
+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.
+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.
 
 ```
 

package/lib/instrumentation-security/hooks/@nestjs/nr-nestjs-core.js

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: New Relic Pre-Release
+ */
+
+'use strict'
+
+const secUtils = require('../../core/sec-utils');
+const { ATTHERATE, DOUBLE_DOLLAR, EMPTY_STR } = require('../../core/constants');
+const routeManager = require('../../core/route-manager');
+const API = require("../../../nr-security-api");
+const logger = API.getLogger();
+const semver = require('semver')
+
+const RequestMethods = {
+  "0": "GET",
+  "1": "POST",
+  "2": "PUT",
+  "3": "DELETE",
+  "4": "PATCH",
+  "5": "ALL",
+  "6": "OPTIONS",
+  "7": "HEAD",
+  "8": "SEARCH",
+}
+
+module.exports = function initialize(shim) {
+  const nestJsVersion = shim.require('./package.json').version
+  logger.info("Instrumenting nestjs", nestJsVersion)
+  if (semver.lt(nestJsVersion, '8.0.0')) {
+    logger.debug(
+      `Not instrumenting Nest.js version ${nestJsVersion}; minimum instrumentable version is 8.0.0`
+    )
+    return
+  }
+
+  const routerExplorer = shim.require("./router/router-explorer").RouterExplorer;
+
+  shim.wrap(routerExplorer.prototype, 'applyCallbackToRouter', function wrapApplyCallbackToRouter(shim, fn) {
+    if (!shim.isFunction(fn)) {
+      return fn
+    }
+    return function wrappedApplyCallbackToRouter() {
+      try {
+        const stakTrace = secUtils.traceElementForRoute();
+        const splittedStack = stakTrace[0].split(DOUBLE_DOLLAR);
+        const verb = RequestMethods[arguments[1].requestMethod];
+        const path = (arguments[4].ctrlPath) + (arguments[1].path[0] == '/' ? EMPTY_STR : arguments[1].path[0]);
+        const key = verb + ATTHERATE + path;
+        routeManager.setRoute(key, splittedStack[0]);
+      } catch (error) {
+      }
+      return fn.apply(this, arguments);
+    }
+  })
+
+}
+
+
+
+
+

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

@@ -136,7 +136,7 @@ function openHook(shim, mod, moduleName) {
         const trimedURL = url.split(QUESTIONMARK)[0];
         if (!trimedURL.includes(path.basename(parameters[0])) || decodedURL.includes(DOTDOTSLASH) || dynamicScanningFlag) {
           try {
-            if (parameters[0].startsWith(DOTDOTSLADH)) {
+            if (parameters[0].startsWith(DOTDOTSLASH)) {
               parameters[0] = agentModule.applicationInfo.serverInfo.deployedApplications[0].deployedPath + SLASH + parameters[0];
             } else if (parameters[0].startsWith(SLASHDOTDOT)) {
               parameters[0] = agentModule.applicationInfo.serverInfo.deployedApplications[0].deployedPath + parameters[0];

package/lib/instrumentation-security/index.js

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

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

@@ -589,7 +589,7 @@ function setPodProperties (identifier, containerProp) {
         podProp.namespace = getPodNameSpace();
         podProp.name = getHostName();
         podProp.creationTimestamp = new Date().getTime();
-        podProp.ContainerProperties.push(containerProp);
+        podProp.containerProperties.push(containerProp);
         logger.debug("podProp:", podProp);
     } catch (e) {
         logger.error(e);

package/lib/nr-security-agent/lib/core/connections/websocket/response/fuzz-request-handler.js

@@ -180,7 +180,10 @@ function handleFuzzResponse(response, fuzzDetails) {
  */
 function parseAxiosHttpRequestToFuzz(requestObject) {
     let serverName = requestObject.serverName ? requestObject.serverName : LOCALHOST;
-    let host = serverName + COLON + requestObject.serverPort
+    let host = serverName + COLON + requestObject.serverPort;
+    if(requestObject.headers && requestObject.headers['content-length']){
+        delete requestObject.headers['content-length'];
+    }
     return {
         url: requestObject.protocol + COLON_SLASH_SLASH + host + requestObject.url,
         method: requestObject.method,

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

@@ -17,7 +17,7 @@ const hc = require('../../health-check');
 const fs = require('fs');
 const { promisify } = require('../../sec-util');
 const ResponseHandler = require('./response');
-const { EMPTY_APPLICATION_UUID, LOG_MESSAGES, CSEC_SEP, NR_CSEC_FUZZ_REQUEST_ID, EXITEVENT,JSON_NAME, RASP } = require('../../sec-agent-constants');
+const { EMPTY_APPLICATION_UUID, LOG_MESSAGES, CSEC_SEP, NR_CSEC_FUZZ_REQUEST_ID, EXITEVENT, JSON_NAME, RASP } = require('../../sec-agent-constants');
 const statusUtils = require('../../statusUtils');
 const commonUtils = require('../../commonUtils');
 const IASTUtil = require('../websocket/response/IASTUtils');
@@ -111,7 +111,7 @@ SecWebSocket.prototype.init = function init() {
         logger.error("Error in reading certificate:", error);
     }
 
-    webSocket = new WebSocket(validatorService, null, { headers: authHeaders, cert: cert, handshakeTimeout: 10000 });
+    webSocket = new WebSocket(validatorService, { headers: authHeaders, cert: cert, handshakeTimeout: 10000 });
 
     webSocket.on(WS_ON_OPEN, this.openCB);
     webSocket.on(WS_ON_MSG, this.msgCB);
@@ -228,12 +228,14 @@ SecWebSocket.prototype.dispatch = async function dispatch(event) {
         await promisify(this.instance, this.instance.send)(eventStr, { mask: true }, () => {
             logger.debug(LOG_MESSAGES.EVENT_SENT + eventStr);
             if (event.jsonName == JSON_NAME.EVENT) {
-                if (NRAgent.config.security.mode == RASP) {
-                    hc.getInstance().raspEventStats.sent++;
+
+                if (event.httpRequest && event.httpRequest.headers[NR_CSEC_FUZZ_REQUEST_ID]) {
+                    hc.getInstance().iastEventStats.sent++;
                 }
                 else {
-                    hc.getInstance().iastEventStats.sent++;
+                    hc.getInstance().raspEventStats.sent++;
                 }
+
             }
             if (event.jsonName == EXITEVENT) {
                 hc.getInstance().exitEventStats.sent++;
@@ -318,12 +320,13 @@ const handleDispatchFailure = (self, event, eventStr) => {
     // so feeding an old applicationinfo JSON would be incorrect
     if (eventStr && event.jsonName !== APPLICATION_INFO_JSON_NAME) {
         hc.getInstance().registerEventDrop();
-        if (NRAgent.config.security.mode == "RASP") {
-            hc.getInstance().raspEventStats.errorCount++;
+        if (event.httpRequest && event.httpRequest.headers[NR_CSEC_FUZZ_REQUEST_ID]) {
+            hc.getInstance().iastEventStats.errorCount++;
         }
         else {
-            hc.getInstance().iastEventStats.errorCount++;
+            hc.getInstance().raspEventStats.errorCount++;
         }
+
     }
 };
 

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

@@ -66,13 +66,13 @@ const sleep = (timeout) => new Promise((resolve) => {
 function generateSecEvent(securityMetadata) {
     const traceObject = securityMetadata.traceObject;
     const request = securityMetadata.request;
-    if (NRAgent.config.security.mode == RASP) {
-        HC.getInstance().raspEventStats.processed++;
-    }
-    else {
+
+    if(request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]){
         HC.getInstance().iastEventStats.processed++;
     }
-
+    else{
+        HC.getInstance().raspEventStats.processed++;
+    }
     try {
         let stakTrace = traceObject.stacktrace;
         let uri = EMPTY_STR;
@@ -102,12 +102,13 @@ function generateSecEvent(securityMetadata) {
     } catch (e) {
         statusUtils.addErrortoBuffer(e);
         logger.error("Error in generating event:", e);
-        if (NRAgent.config.security.mode == RASP) {
-            HC.getInstance().raspEventStats.errorCount++;
-        }
-        else {
+       
+        if(request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]){
             HC.getInstance().iastEventStats.errorCount++;
         }
+        else{
+            HC.getInstance().raspEventStats.errorCount++;
+        }
     }
 
 }

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

@@ -23,7 +23,7 @@ const {
     }
 } = require('./connections/websocket');
 const { HC_INTERVAL_MS } = require('../../resources/config');
-const { LOG_DIR } = require('./sec-agent-constants');
+const { LOG_DIR, EXITEVENT, JSON_NAME } = require('./sec-agent-constants');
 const statusUtils = require('./statusUtils');
 const njsAgentConstants = require('./sec-agent-constants');
 
@@ -100,6 +100,7 @@ const sendHC = async function () {
         json = JSON.parse(json);
         json.policyVersion = applicationInfo.policyVersion;
         json.entityGuid = applicationInfo.entityGuid;
+
         try {
             json.stats = await commonUtils.getHCStats();
         } catch (error) {
@@ -114,6 +115,12 @@ const sendHC = async function () {
         json.serviceStatus.agentActiveStat = commonUtils.isAgentActiveState();
         json.serviceStatus.iastRestClient = commonUtils.iastRestClientStatus();
 
+        json.exitEventSentCount = json.exitEventStats.sent;
+        json.eventRejectionCount = json.raspEventStats.rejected + json.iastEventStats.rejected;
+        json.eventProcessingErrorCount = json.raspEventStats.errorCount + json.iastEventStats.errorCount;
+        json.eventSendRejectionCount = json.eventRejectionCount;
+        json.eventSendErrorCount = json.eventProcessingErrorCount;
+
         hc.getInstance().resetDropCount();
         hc.getInstance().resetProcessedCount();
         hc.getInstance().resetEventSentCount();
@@ -134,13 +141,13 @@ const sendHC = async function () {
  */
 function getDispatcherAndSendEvent(eventJson) {
     const eventType = eventJson.jsonName;
-    if (eventType === 'Event') {
+    if (eventType === JSON_NAME.EVENT || eventType === EXITEVENT) {
         hc.getInstance().registerEventProcessed();
     }
 
     dispatcher(eventJson);
 
-    if (eventType === 'Event') {
+    if (eventType === JSON_NAME.EVENT || eventType === EXITEVENT) {
         hc.getInstance().registerEventSent();
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "New Relic Security Agent for Node.js",
   "main": "index.js",
   "jsonVersion": "1.1.0",
@@ -35,9 +35,9 @@
     "url": "https://github.com/newrelic/csec-node-agent.git"
   },
   "dependencies": {
-    "@aws-sdk/client-lambda": "^3.363.0",
-    "axios": "0.21.4",
-    "check-disk-space": "3.3.1",
+    "@aws-sdk/client-lambda": "^3.436.0",
+    "axios": "1.6.0",
+    "check-disk-space": "3.4.0",
     "content-type": "^1.0.5",
     "fast-safe-stringify": "^2.1.1",
     "find-package-json": "^1.2.0",
@@ -55,8 +55,8 @@
     "sync-request": "^6.1.0",
     "unescape": "^1.0.1",
     "unescape-js": "^1.1.4",
-    "uuid": "^9.0.0",
-    "ws": "^7.5.9"
+    "uuid": "^9.0.1",
+    "ws": "^8.14.2"
   },
   "devDependencies": {
     "@hapi/hapi": "^21.3.0",