@newrelic/security-agent 1.4.0 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+### v2.0.0 (2024-09-20)
+### ⚠ BREAKING CHANGES
+* Dropped support for Node.js v16
+* Dropped functionality to generate snapshot file
+#### Features
+* Support to honour proxy settings via config
+* Support for secure cookie security event generation
+* Report error to Error Inbox upon connection failure to Security Engine
+* Support to detect application and server path
+* Functionality to truncate Incoming HTTP request upto default limit
+* Dropped support for Node.js v16
+* Dropped functionality to generate snapshot file
+#### Bug fixes
+* Handling for empty data in IAST fuzzing header
+* Added identifiers in events
+* Fix for file integrity security event generation
+* Fix for missing identifiers in iast-data-request JSON
+
+### v1.5.0 (2024-08-14)
+#### Features
+* Support for Node.js v22.x
+#### Bug fixes
+* Fix for traceId in error reporting
+#### Miscellaneous chores
+* (deps): bumped axios from 1.6.8 to 1.7.4 
+* (deps-dev): bumped ws from 7.5.9 to 8.18.0
+#### Continuous integration
+* Added Node.js v22.x to unit tests
+
 ### v1.4.0 (2024-06-24)
 #### Features
 * Added support to report application's errors while IAST scanning

package/THIRD_PARTY_NOTICES.md

@@ -21,6 +21,7 @@ code, the source code can be found at [https://github.com/newrelic/csec-node-age
 * [find-package-json](#find-package-json)
 * [hash.js](#hashjs)
 * [html-entities](#html-entities)
+* [https-proxy-agent](#https-proxy-agent)
 * [is-invalid-path](#is-invalid-path)
 * [js-yaml](#js-yaml)
 * [jsonschema](#jsonschema)
@@ -77,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.2](https://github.com/axios/axios/tree/v1.7.2)), distributed under the [MIT License](https://github.com/axios/axios/blob/v1.7.2/LICENSE):
+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):
 
 ```
 # Copyright (c) 2014-present Matt Zabriskie & Collaborators
@@ -239,6 +240,22 @@ THE SOFTWARE.
 
 ```
 
+### https-proxy-agent
+
+This product includes source derived from [https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent) ([v5.0.1](https://github.com/TooTallNate/node-https-proxy-agent/tree/v5.0.1)), distributed under the [MIT License](https://github.com/TooTallNate/node-https-proxy-agent/blob/v5.0.1/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.
+```
+
 ### is-invalid-path
 
 This product includes source derived from [is-invalid-path](https://github.com/jonschlinkert/is-invalid-path) ([v1.0.2](https://github.com/jonschlinkert/is-invalid-path/tree/v1.0.2)), distributed under the [MIT License](https://github.com/jonschlinkert/is-invalid-path/blob/v1.0.2/LICENSE):
@@ -588,7 +605,7 @@ 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) ([v8.17.1](https://github.com/websockets/ws/tree/v8.17.1)), distributed under the [MIT License](https://github.com/websockets/ws/blob/v8.17.1/LICENSE):
+This product includes source derived from [ws](https://github.com/websockets/ws) ([v8.18.0](https://github.com/websockets/ws/tree/v8.18.0)), distributed under the [MIT License](https://github.com/websockets/ws/blob/v8.18.0/LICENSE):
 
 ```
 Copyright (c) 2011 Einar Otto Stangvik <einaros@gmail.com>

package/lib/instrumentation-security/core/constants.js

@@ -62,6 +62,13 @@ module.exports = {
     UNDEFINED: 'undefined',
     SELF_FD_PATH: '/proc/self/fd/',
     NR_CSEC_FUZZ_REQUEST_ID: 'nr-csec-fuzz-request-id',
-    ASTERISK: "*"
+    ASTERISK: "*",
+    COMMA_SPACE: ", ",
+    SEMI_COLON: ';',
+    EQUAL: '=',
+    SECURE: 'secure',
+    HTTPONLY: 'httponly',
+    SAMESITE: 'samesite',
+    STRICT: 'strict'
 
 };

package/lib/instrumentation-security/core/event-constants.js

@@ -20,9 +20,10 @@ const EVENT_TYPE = {
     UNVALIDATED_REDIRECT: 'UNVALIDATED_REDIRECT',
     REFLECTED_XSS: 'REFLECTED_XSS',
     XPATH: 'XPATH',
-    LDAP: 'LDAP'
+    LDAP: 'LDAP',
+    SECURE_COOKIE: 'SECURE_COOKIE'
 }
-const  EVENT_CATEGORY =  {
+const EVENT_CATEGORY = {
     MYSQL: 'MYSQL',
     POSTGRES: 'POSTGRES',
     ORACLE: 'ORACLE',
@@ -40,7 +41,8 @@ const  EVENT_CATEGORY =  {
     UNVALIDATED_REDIRECT: 'UNVALIDATED_REDIRECT',
     REFLECTED_XSS: 'REFLECTED_XSS',
     XPATH: 'XPATH',
-    LDAP: 'LDAP'
+    LDAP: 'LDAP',
+    SECURE_COOKIE: 'SECURE_COOKIE'
 }
 
 module.exports = {

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

@@ -48,13 +48,14 @@ function getRequest(shim) {
  * @param {*} shim 
  * @param {*} data 
  */
-function updateRequestBody(shim, data) {
+function updateRequestBody(shim, data, isTruncated) {
     const segment = shim.getActiveSegment();
     if (segment) {
         const transactionId = segment.transaction.id;
         const requestData = getRequestFromId(transactionId);
         if (requestData) {
             requestData.body = data;
+            requestData.dataTruncated = isTruncated;
             setRequest(transactionId, requestData);
         }
     }
@@ -65,6 +66,7 @@ function updateRequestBody(shim, data) {
             const requestData = getRequestFromId(traceId);
             if (requestData) {
                 requestData.body = data;
+                requestData.dataTruncated = isTruncated;
                 setRequest(traceId, requestData)
             }
         }

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

@@ -194,6 +194,7 @@ function addRequestData(shim, request) {
                 });
             }
             data.clientIP = requestIp.getClientIp(request);
+            data.dataTruncated = false;
             const transactionId = segment.transaction.id;
             const storedRequest = requestManager.getRequestFromId(transactionId);
             if (storedRequest && storedRequest.uri) {

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

@@ -25,6 +25,7 @@ const RENAME = 'rename';
 const FSReqCallback = 'FSReqCallback';
 const FSReqWrap = 'FSReqWrap';
 const OBJECT = 'object';
+const semver = require('semver');
 
 const functionsProbableToFA = [
   "fstat",
@@ -37,7 +38,7 @@ const functionsProbableToFA = [
   "realpath",
 ];
 
-const functionProbableToFI = [
+let functionProbableToFI = [
   "rename",
   "ftruncate",
   "rmdir",
@@ -214,6 +215,9 @@ function probableToFAHooks(shim, mod, moduleName) {
  * @param {*} moduleName 
  */
 function probableToFIHooks(shim, mod, moduleName) {
+  if (semver.satisfies(process.version, '>19.0.0')) {
+    functionProbableToFI.push('writeFileSync');
+  }
   functionProbableToFI.forEach(function (fun) {
     shim.wrap(mod, fun, function makeFIWrapper(shim, fn) {
       logger.debug(`Instrumenting ${moduleName}.${fun}`);
@@ -228,7 +232,7 @@ function probableToFIHooks(shim, mod, moduleName) {
             parameters[0] = path.resolve(parameters[0]);
             parameters[1] = path.resolve(parameters[1]);
           } catch (error) {
-            
+
           }
           let absoluteParameters = [parameters[0]];
           if (fun === COPY_FILE || fun === RENAME) {

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

@@ -5,7 +5,7 @@
 
 module.exports = initialize
 const requestManager = require('../../core/request-manager');
-const { NR_CSEC_FUZZ_REQUEST_ID, QUESTION_MARK, EMPTY_STRING, UTF8, CONTENT_TYPE, TEXT_HTML, APPLICATION_JSON, APPLICATION_XML, APPLICATION_XHTML, TEXT_PLAIN, APPLICATION_X_FORM_URLENCODED, MULTIPART_FORM_DATA, COMMA } = require('../../core/constants');
+const { NR_CSEC_FUZZ_REQUEST_ID, QUESTION_MARK, EMPTY_STRING, UTF8, CONTENT_TYPE, TEXT_HTML, APPLICATION_JSON, APPLICATION_XML, APPLICATION_XHTML, TEXT_PLAIN, APPLICATION_X_FORM_URLENCODED, MULTIPART_FORM_DATA, COMMA, SEMI_COLON, EQUAL, SECURE, HTTPONLY, SAMESITE, STRICT } = require('../../core/constants');
 const ARRAY_TYPE = 'Array';
 const STRING_TYPE = 'string';
 const BUFFER_TYPE = 'Buffer';
@@ -40,6 +40,7 @@ let CSEC_HOME = NRAgent && NRAgent.config.newrelic_home ? NRAgent.config.newreli
 const CSEC_HOME_TMP = `${CSEC_HOME}/nr-security-home/tmp/language-agent/${process.env.applicationUUID}`
 let lastTransactionId = EMPTY_STRING;
 let uncaughtExceptionReportFlag = false;
+const requestBodyLimit = 500;
 
 
 /**
@@ -172,8 +173,12 @@ function parseFuzzheaders(requestData, transactionId) {
       const additionalData = fuzzheaders[NR_CSEC_FUZZ_REQUEST_ID].split(CSEC_SEP);
       logger.debug('AdditionalData:', additionalData);
       if (additionalData.length >= 8) {
-        let encryptedData = additionalData[6];
-        let hashVerifier = additionalData[7];
+        let encryptedData = additionalData[6].trim();
+        let hashVerifier = additionalData[7].trim();
+        
+        if (lodash.isEmpty(encryptedData) || lodash.isEmpty(hashVerifier)) {
+          return;
+        }
         let decryptedData = secUtils.decryptData(encryptedData);
         let verifiedHash = secUtils.hashVerifier(decryptedData, hashVerifier);
         logger.debug("verifiedHash:", verifiedHash);
@@ -244,6 +249,7 @@ function addRequestData(shim, request) {
         });
       }
       data.clientIP = requestIp.getClientIp(request);
+      data.dataTruncated = false;
       const transactionId = segment.transaction.id;
       const storedRequest = requestManager.getRequestFromId(transactionId);
       lastTransactionId = transactionId;
@@ -363,7 +369,21 @@ function onDataHook(shim, mod) {
         const requestData = requestManager.getRequestFromId(transactionId);
         if (requestData) {
           data = requestData.body ? requestData.body.concat(chunk.toString()) : chunk.toString();
-          requestManager.updateRequestBody(shim, data);
+          requestManager.updateRequestBody(shim, data, false);
+          try {
+            const contentLength = Buffer.byteLength(data, 'utf8');
+            let bodyLimit = requestBodyLimit;
+            if (!isNaN(bodyLimit)) {
+              bodyLimit = bodyLimit * 1000;
+              if (contentLength && contentLength > bodyLimit) {
+                data = truncateStringToBytes(data, bodyLimit);
+                requestManager.updateRequestBody(shim, data, true);
+              }
+            }
+
+          } catch (error) {
+            logger.error("Error while truncating request body", error);
+          }
         }
 
       }
@@ -418,6 +438,11 @@ function responseHook(resp, req, shim) {
       } catch (error) {
         logger.debug("Error while reporting error", error);
       }
+      try {
+        secureCookieCheck(response, shim);
+      } catch (error) {
+        logger.debug("Error while generating secure cookie event");
+      }
 
       responseBodyCompute(response, arguments);
 
@@ -594,7 +619,7 @@ function deleteTempFileForIAST(file) {
  */
 process.on('uncaughtException', (err, origin) => {
   console.error(err);
-  if(uncaughtExceptionReportFlag){
+  if (uncaughtExceptionReportFlag) {
     process.exit(1);
   }
   const request = requestManager.getRequestFromId(lastTransactionId);
@@ -606,3 +631,96 @@ process.on('uncaughtException', (err, origin) => {
   uncaughtExceptionReportFlag = true;
 });
 
+/**
+ * utility to parse response headers for cookie check
+ * @param {*} headersString 
+ * @returns 
+ */
+function responseRawHeaderParsing(headersString) {
+  let setCookieValue;
+  try {
+    const headersArray = headersString.split('\r\n');
+    for (const header of headersArray) {
+      if (header.toLowerCase().startsWith('set-cookie:')) {
+        setCookieValue = header.trim().replace('set-cookie:', '');
+        break;
+      }
+    }
+  } catch (error) {
+
+  }
+  return setCookieValue;
+}
+
+/**
+ * Utility to check insecure cookie settings
+ * @param {*} response 
+ * @param {*} shim 
+ */
+function secureCookieCheck(response, shim) {
+  let cookieHeader = response.getHeader('set-cookie') ? response.getHeader('set-cookie') : responseRawHeaderParsing(response._header);
+  let cookieHeaderList = [];
+  if (!cookieHeader) {
+    return;
+  }
+  if (typeof cookieHeader === 'string') {
+    cookieHeaderList.push(cookieHeader)
+  }
+  else {
+    cookieHeaderList = cookieHeaderList.concat(cookieHeader);
+  }
+  let csec_request = requestManager.getRequest(shim);
+  try {
+    let parameters = [];
+    for (const cookieString of cookieHeaderList) {
+      if (cookieString) {
+        const keyValuePairs = cookieString.split(SEMI_COLON);
+        let params = {
+          "isHttpOnly": false,
+          "isSecure": false,
+          "isSameSiteStrict": false,
+        };
+        for (let i = 0; i < keyValuePairs.length; i++) {
+          const pair = keyValuePairs[i];
+          const [key, value] = pair.trim().split(EQUAL);
+          if (i == 0) {
+            params.name = key;
+            params.value = value;
+          }
+
+          if (key.toLowerCase() === SECURE) {
+            params.isSecure = true;
+          }
+          else if (key.toLowerCase() === HTTPONLY) {
+            params.isHttpOnly = true;
+          }
+          else if (key.toLowerCase() === SAMESITE && value.toLowerCase() === STRICT) {
+            params.isSameSiteStrict = true;
+          }
+        }
+        parameters.push(params);
+      }
+    }
+    const traceObject = secUtils.getTraceObject(shim);
+    const secMetadata = securityMetaData.getSecurityMetaData(csec_request, parameters, traceObject, secUtils.getExecutionId(), EVENT_TYPE.SECURE_COOKIE, EVENT_CATEGORY.SECURE_COOKIE)
+    const secEvent = API.generateSecEvent(secMetadata);
+    API.sendEvent(secEvent);
+  } catch (error) {
+    logger.debug("Error while generating secure cookie event:", error);
+  }
+
+}
+
+function truncateStringToBytes(inputString, maxBytes) {
+  if (!inputString || maxBytes <= 0) {
+    return EMPTY_STRING; // Return an empty string if input is invalid
+  }
+  const buffer = Buffer.from(inputString, UTF8);
+  if (buffer.length <= maxBytes) {
+    return inputString;
+  }
+  const truncatedBuffer = buffer.slice(0, maxBytes);
+  const truncatedString = truncatedBuffer.toString(UTF8);
+  return truncatedString;
+}
+

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

@@ -43,6 +43,7 @@ function AuthHeaders() {
         commonUtils.addLogEventtoBuffer(logMessage);
     }
 
+
     return authHeaders;
 }
 AuthHeaders.prototype.constructor = AuthHeaders;

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

@@ -98,9 +98,7 @@ function exceptionReporting(exception, request, responseCode) {
             this.category = exception.name;
             this.traceId = shaUtil.getSHA256ForData(this.exception.stackTrace.join('|') + this.category + this.httpRequest.route + this.httpRequest.method);
         }
-        else {
-            this.traceId = shaUtil.getSHA256ForData(this.category + this.httpRequest.route + this.httpRequest.method);
-        }
+        
         if (responseCode) {
             if (responseCode >= 500) {
                 this.category = http.STATUS_CODES[responseCode];
@@ -124,6 +122,9 @@ function exceptionReporting(exception, request, responseCode) {
 function generateExceptionReportingEvent(error, request) {
     try {
         const exception = new exceptionReporting(error, request);
+        if(!exception.traceId){
+            return;
+        }
         let key = exception.exception.type + exception.exception.stackTrace[0];
         if (!exceptionsMap.has(key)) {
             exceptionsMap.set(key, exception);
@@ -141,6 +142,9 @@ function generateExceptionReportingEvent(error, request) {
 function generate5xxReportingEvent(error, request, responseCode) {
     try {
         const exception = new exceptionReporting(error, request, responseCode);
+        if(!exception.traceId){
+            return;
+        }
         let key = (request.uri ? request.uri : request.url) + responseCode;
         if (!exceptionsMap.has(key)) {
             exceptionsMap.set(key, exception);

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

@@ -17,7 +17,6 @@ const logger = logs.getLogger();
 const initLogger = logs.getInitLogger();
 const jsonValidator = require('./jsonValidator');
 const LOG_MESSAGES = require('./sec-agent-constants').LOG_MESSAGES;
-const statusUtils = require('./statusUtils');
 
 function Policy() {
     this.data = {};
@@ -72,7 +71,6 @@ function setDefaultPolicy() {
         logger.info(LOG_MESSAGES.DEFAULT_POL_SET, JSON.stringify(policy.data));
     } catch (e) {
         logger.error(LOG_MESSAGES.UNABLE_SET_DEFAULT_POL, e);
-        statusUtils.addErrortoBuffer(e);
     };
 }
 
@@ -90,16 +88,6 @@ function appInfoVersionUpdate(policy, data) {
     }
 }
 
-/**
- * Function to send updated policy to validator
- * @param {*} data 
- */
-function sendUpdatedPolicy(data) {
-    const wsClient = Agent.getAgent().client;
-    let updatedPolicy = Object.assign({}, data);
-    updatedPolicy.jsonName = 'lc-policy';
-    wsClient.dispatcher(updatedPolicy);
-}
 module.exports = {
     getInstance,
     setPolicyData,

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

@@ -130,7 +130,8 @@ Agent.setNRAgent = function setNRAgent(agent) {
     }
     const CSECAgent = Agent.getAgent();
     if (CSECAgent) {
-        CSECAgent.applicationInfo.entityGuid = NRAgent.config.entity_guid;
+        CSECAgent.applicationInfo.appEntityGuid = NRAgent.config.entity_guid;
+        CSECAgent.applicationInfo.appAccountId = NRAgent.config.account_id;
         CSECAgent.applicationInfo.linkingMetadata = LinkingMetaData.getLinkingMetadata();
         CSECAgent.applicationInfo.linkingMetadata.agentRunId = NRAgent.config.run_id;
         CSECAgent.setApplicationInfo(CSECAgent.applicationInfo);

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

@@ -90,10 +90,10 @@ function ApplicationInfo () {
     const k8sHost = isK8S();
     const ECSEnv = isECSEnv();
     const isLambda = IS_LAMBDA_ENV;
-
     this.jsonName = APPLICATION_INFO_KEYWORD;
     if (NRAgent && NRAgent.config) {
-        this.entityGuid = NRAgent.config.entity_guid;
+        this.appEntityGuid = NRAgent.config.entity_guid;
+        this.appAccountId = NRAgent.config.account_id;
     }
     this.eventType = 'sec_appinfo';
     this.startTime = Date.now();

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

@@ -133,7 +133,6 @@ function getOS() {
 function createDirectories() {
     createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home`);
     createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home${SLASH}logs`);
-    createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home${SLASH}logs${SLASH}snapshots`);
     createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home${SLASH}tmp`);
     createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home${SLASH}tmp${SLASH}language-agent`);
     createPathIfNotExist(`${CSEC_HOME}${SLASH}nr-security-home${SLASH}tmp${SLASH}language-agent${SLASH}${getUUID()}`);
@@ -159,14 +158,11 @@ async function initialSetup() {
  */
 function isLogAccessible(logFileName) {
     return new Promise((resolve) => {
-        if (logFileName === njsAgentConstants.STATUS_LOG_FILE && require('./statusUtils').getBufferedHC().length === 0) {
-            resolve('OK');
-        }
         fs.access(logFileName, fs.constants.F_OK | fs.constants.W_OK, (err) => {
             if (err) {
                 resolve('Error');
             }
-            else if ((!logs.isLoggerOk || logger.level.levelStr == 'OFF') && logFileName != njsAgentConstants.STATUS_LOG_FILE) {
+            else if ((!logs.isLoggerOk || logger.level.levelStr == 'OFF')) {
                 resolve('Error');
             }
             else {
@@ -256,42 +252,6 @@ function isAgentActiveState() {
 function iastRestClientStatus() {
     return 'OK';
 }
-/**
- * Utiltity to remove older snapshots
- */
-function removeOlderSnapshots() {
-    try {
-        const basePath = njsAgentConstants.LOG_DIR + 'snapshots' + SLASH;
-        const directoryContent = fs.readdirSync(basePath);
-        const files = directoryContent.filter((filename) => {
-            return fs.statSync(`${basePath}${SLASH}${filename}`).isFile();
-        });
-        const sorted = files.sort((a, b) => {
-            const firstStat = fs.statSync(`${basePath}${SLASH}${a}`);
-            const secondStat = fs.statSync(`${basePath}${SLASH}${b}`);
-            return new Date(secondStat.mtime).getTime() - new Date(firstStat.mtime).getTime();
-        });
-        for (let i = 99; i < sorted.length; i++) {
-            const fileToDelete = basePath + sorted[i];
-            try {
-                fs.unlink(fileToDelete, (err) => {
-                    if (err) {
-                        logger.error(err);
-                    } else {
-                        logger.debug('Snapshot deleted:', fileToDelete);
-                    }
-                });
-            } catch (error) {
-                logger.error(error);
-            }
-        }
-    } catch (error) {
-        logger.debug(error);
-        const LogMessage = require('./LogMessage');
-        const logMessage = new LogMessage.logMessage("DEBUG", 'Error in processing snapshot files', __filename, error);
-        addLogEventtoBuffer(logMessage);
-    }
-}
 /**
  * Utilty to remove older log files.
  */
@@ -459,6 +419,14 @@ function getFramework(){
     return framework;
 }
 
+/**
+ * Utility to send error to error inbox of APM
+ * @param {*} error 
+ */
+function sendErrorToErrorInbox(error){
+    API.newrelic.noticeError(error);
+}
+
 
 module.exports = {
     getUUID,
@@ -475,7 +443,6 @@ module.exports = {
     getHCStats,
     isAgentActiveState,
     iastRestClientStatus,
-    removeOlderSnapshots,
     logRollOver,
     getValidatorServiceEndpointURL,
     getCSECmode,
@@ -484,5 +451,6 @@ module.exports = {
     setWSHealthStatus,
     addLogEventtoBuffer,
     getLogEvents,
-    getFramework
+    getFramework,
+    sendErrorToErrorInbox
 };

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

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2024 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: New Relic Software License v1.0
+ */
+
+'use strict'
+
+const { HttpsProxyAgent } = require('https-proxy-agent')
+const logs = require('../../logging');
+let logger = logs.getLogger();
+const commonUtils = require('../../commonUtils');
+const fs = require('fs');
+
+let agentProxyWithKeepAlive = null
+
+exports.proxyAgent = function proxyAgent(config) {
+  if (null !== agentProxyWithKeepAlive) {
+    return agentProxyWithKeepAlive
+  }
+  const proxyUrl = proxyOptions(config)
+  let proxyOpts = {
+    secureEndpoint: config.ssl,
+    auth: proxyUrl.auth,
+    ca: config?.certificates?.length ? config.certificates : [],
+    keepAlive: true
+  }
+  let cert = '';
+  try {
+    const certPath = commonUtils.getPathOfCACert();
+    cert = fs.readFileSync(certPath, 'utf8');
+  } catch (error) {
+    logger.error("Error in reading certificate:", error);
+
+  }
+  proxyOpts.ca.push(cert);
+  logger.info(`Using proxy: ${proxyUrl}`)
+  agentProxyWithKeepAlive = new HttpsProxyAgent(proxyUrl, proxyOpts)
+  return agentProxyWithKeepAlive
+}
+
+/**
+ * Utility to create proxy URL
+ * @param config 
+ * @returns 
+ */
+function proxyOptions(config) {
+  let proxyUrl
+  if (config.proxy) {
+    proxyUrl = config.proxy
+  } else {
+    proxyUrl = 'https://'
+    let proxyAuth = config.proxy_user
+    if (config.proxy_pass !== '') {
+      proxyAuth += ':' + config.proxy_pass
+      proxyUrl += `${proxyAuth}@`
+    }
+
+    proxyUrl += `${config.proxy_host || 'localhost'}:${config.proxy_port || 80}`
+  }
+  return proxyUrl
+}

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

@@ -31,7 +31,7 @@ function completedRequestsMapInit(id) {
 
 function addCompletedRequests(id, eventId) {
     let data = completedRequestsMap.get(id);
-    if(!data){
+    if (!data) {
         return;
     }
     data.push(eventId);
@@ -42,15 +42,15 @@ function getCompletedRequestsMap() {
     return completedRequestsMap;
 }
 
-function clearCompletedRequestMap(){
+function clearCompletedRequestMap() {
     completedRequestsMap.clear();
 }
 
-function clearPendingRequestIdSet(){
+function clearPendingRequestIdSet() {
     pendingRequestIds.clear();
 }
 
-function IASTCleanup(){
+function IASTCleanup() {
     clearCompletedRequestMap();
     clearPendingRequestIdSet();
 }
@@ -69,6 +69,8 @@ function generateIASTDataRequest() {
     let object = {};
     object['jsonName'] = 'iast-data-request';
     object['applicationUUID'] = Agent.getAgent().applicationInfo.applicationUUID;
+    object['appEntityGuid'] = Agent.getAgent().applicationInfo.appEntityGuid;
+    object['appAccountId'] = Agent.getAgent().applicationInfo.appAccountId;
     object["batchSize"] = batchSize ? batchSize : 300;
     object['pendingRequestIds'] = getPendingRequestIds();
     object['completedRequests'] = Object.fromEntries(getCompletedRequestsMap());

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

@@ -21,7 +21,6 @@ const LogMessage = require('../../../LogMessage');
 require('dns').setDefaultResultOrder('ipv4first')
 const PolicyManager = require('../../../Policy');
 
-const statusUtils = require('../../../statusUtils');
 
 const find = `${SLASH}{{NR_CSEC_VALIDATOR_HOME_TMP}}`;
 const CSEC_HOME_TMP_CONST = new RegExp(find, 'g');
@@ -158,7 +157,6 @@ function handleFuzzRequest(fuzzDetails) {
             handleFuzzResponse(response, fuzzDetails);
         }
     } catch (err) {
-        statusUtils.addErrortoBuffer(err);
         const fuzzFailEvent = new FuzzFailEvent(fuzzRequest.headers[NR_CSEC_FUZZ_REQUEST_ID]);
         logger.error(stringify(fuzzFailEvent));
         try {

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

@@ -17,11 +17,11 @@ 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, SEVERE } = require('../../sec-agent-constants');
-const statusUtils = require('../../statusUtils');
+const { EMPTY_APPLICATION_UUID, LOG_MESSAGES, CSEC_SEP, NR_CSEC_FUZZ_REQUEST_ID, EXITEVENT, JSON_NAME, SEVERE } = require('../../sec-agent-constants');
 const commonUtils = require('../../commonUtils');
 const IASTUtil = require('../websocket/response/IASTUtils');
 const LogMessage = require('../../LogMessage');
+const proxyUtil = require('./proxy-util');
 
 const BUSY = 'busy';
 const IDLE = 'idle';
@@ -105,18 +105,25 @@ SecWebSocket.prototype.init = function init() {
     const authHeaders = require('../../Auth-headers').getInstance();
     initLogger.info(`Connecting to Validator at ${validatorService}`);
     IASTUtil.IASTCleanup();
-    let cert = ''
+    let cert = '';
     try {
         const certPath = commonUtils.getPathOfCACert();
         cert = fs.readFileSync(certPath, 'utf8');
     } catch (error) {
         logger.error("Error in reading certificate:", error);
+        commonUtils.sendErrorToErrorInbox(error)
         const logMessage = new LogMessage.logMessage(SEVERE, 'Error in reading certificate for websocket', __filename, error);
         commonUtils.addLogEventtoBuffer(logMessage);
 
     }
-
-    webSocket = new WebSocket(validatorService, { headers: authHeaders, cert: cert, handshakeTimeout: 10000 });
+    const isProxy = !!(NRAgent.config.proxy || NRAgent.config.proxy_port || NRAgent.config.proxy_host)
+    if(isProxy){
+        const agentWithProxy = proxyUtil.proxyAgent(NRAgent.config);
+        webSocket = new WebSocket(validatorService, { headers: authHeaders, cert: cert, handshakeTimeout: 10000, agent:agentWithProxy });
+    }
+    else{
+        webSocket = new WebSocket(validatorService, { headers: authHeaders, cert: cert, handshakeTimeout: 10000 });
+    }
 
     webSocket.on(WS_ON_OPEN, this.openCB);
     webSocket.on(WS_ON_MSG, this.msgCB);
@@ -162,6 +169,7 @@ SecWebSocket.prototype.reconnect = function reconnect() {
         return;
     }
     commonUtils.setWSHealthStatus('Error');
+    commonUtils.sendErrorToErrorInbox(new Error("Unable to connect to Security Engine"))
     logger.debug(LOG_MESSAGES.DETECTED_BROKEN_CONN);
     this.obeyReconnect();
 
@@ -204,13 +212,11 @@ SecWebSocket.prototype.pingWS = async function pingWS() {
             if (err) {
                 logger.debug("Error while pinging:", err);
                 commonUtils.setWSHealthStatus('Error');
-                statusUtils.addErrortoBuffer(err);
     
             }
         });
     } catch (err) {
         logger.debug("error in ping:", err);
-        statusUtils.addErrortoBuffer(err);
         commonUtils.setWSHealthStatus('Error');
         return;
     }
@@ -266,7 +272,6 @@ SecWebSocket.prototype.dispatch = async function dispatch(event) {
         })
     } catch (error) {
         logger.debug(LOG_MESSAGES.ERROR_WHILE_SEND_EVENT, eventStr, error);
-        statusUtils.addErrortoBuffer(error);
         handleDispatchFailure(this, event, eventStr);
     }
 };
@@ -286,7 +291,6 @@ SecWebSocket.prototype.dispatchApplicationInfo = async function dispatchApplicat
     try {
         await promisify(this.instance, this.instance.send)(eventStr, { mask: true });
     } catch (error) {
-        statusUtils.addErrortoBuffer(error);
         logger.warn('Error while sending applicationInfo:', error);
         this.obeyReconnect();
     }
@@ -325,7 +329,6 @@ SecWebSocket.prototype.flushEventQueue = async function flushEventQueue() {
         const results = await Promise.all(sentEvents);
         hc.getInstance().registerEventsSent(results.length);
     } catch (err) {
-        statusUtils.addErrortoBuffer(err);
         logger.debug('Flush failed, reception of all events on IC couldn\'t be ensured.');
     }
 };
@@ -398,7 +401,7 @@ const defaultOnOpenCB = () => async function onOpen() {
         initLogger.info(LOG_MESSAGES.SENDING_APPINFO_COMPLETE, JSON.stringify(applicationInfo));
     } catch (err) {
         logger.error(`Connection broken: ${err.message}`);
-        statusUtils.addErrortoBuffer(err);
+        commonUtils.sendErrorToErrorInbox(err);
         commonUtils.setWSHealthStatus('Error')
         setWebSocketConn();
         self.setValidatorNotReadyForEvents();
@@ -431,10 +434,10 @@ const defaultOnMsgCB = () => function onMessage(data) {
  */
 const defaultOnErrCB = () => function onClose(error) {
     commonUtils.setWSHealthStatus('Error');
-    statusUtils.addErrortoBuffer(error);
     const self = this;
     logger.error("Error while connecting to validator:", error.message)
     const logMessage = new LogMessage.logMessage(SEVERE, 'Error while connecting to validator', __filename, error);
+    commonUtils.sendErrorToErrorInbox(error);
     commonUtils.addLogEventtoBuffer(logMessage);
     logger.warn("Security Agent INACTIVE!!!")
     if (error && error.code && (error.code === 'ECONNREFUSED' || error.code === 'EPIPE' || error.code === 'ECONNRESET')) {

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

@@ -34,8 +34,8 @@ function BasicInfo() {
     this.policyVersion = (!lodash.isEmpty(policyManager.getInstance().data)) ? policyManager.getInstance().data.version : 'DEFAULT';
 
     if (NRAgent && NRAgent.config) {
-        this.accountId = NRAgent.config.account_id;
-        this.entityGuid = NRAgent.config.entity_guid;
+        this.appAccountId = NRAgent.config.account_id;
+        this.appEntityGuid = NRAgent.config.entity_guid;
         this.linkingMetadata = LinkingMetaData.getLinkingMetadata();
         this.linkingMetadata.agentRunId = NRAgent.config.run_id;
     }

package/lib/nr-security-agent/lib/core/health-check.js

@@ -46,7 +46,8 @@ function HC(info) {
     this.applicationUUID = info.applicationUUID;
     this.eventType = 'sec_health_check_lc';
     if (NRAgent && NRAgent.config) {
-        this.entityGuid = NRAgent.config.entity_guid;
+        this.appEntityGuid = NRAgent.config.entity_guid;
+        this.appAccountId = NRAgent.config.account_id;
     }
     this.protectedServer = NODE_SERVER;
     this.eventDropCount = 0;

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

@@ -24,15 +24,14 @@ module.exports = {
     CSEC_HOME_TMP: `${CSEC_HOME}${sep}nr-security-home${sep}tmp${sep}language-agent${sep}${process.env.applicationUUID}`,
     AGENT_START_TIME: agentStartTime,
     FRAMEWORK: '',
-    STATUS_LOG_FILE: `${CSEC_HOME}${sep}nr-security-home${sep}logs${sep}snapshots${sep}node-security-collector-status-${process.env.applicationUUID}.log`,
-
+   
     DB_LIST: {
         MYSQL: 'MYSQL',
         MYSQL2: 'MYSQL',
         POSTGRES: 'POSTGRES',
         MONGODB: 'MONGODB',
         ORACLEDB: 'ORACLEDB',
-        MSSQL: 'MSSQL',
+        MSSQL: 'MSSQL',          
         SQLITE3: 'SQLITE3'
     },
     SERVER_COMMAND: {

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

@@ -9,16 +9,17 @@ const { SecEvent } = require('./event');
 const logs = require('./logging');
 const { Agent } = require('./agent');
 const shaUtil = require('./sha-size-util');
-const { LOG_MESSAGES, NR_CSEC_FUZZ_REQUEST_ID, COLON, VULNERABLE, EXITEVENT, EMPTY_STR, RASP, SEVERE, HYPHEN } = require('./sec-agent-constants');
+const { NR_CSEC_FUZZ_REQUEST_ID, COLON, VULNERABLE, EXITEVENT, EMPTY_STR, SEVERE, HYPHEN } = require('./sec-agent-constants');
 const API = require('../../../nr-security-api');
 const NRAgent = API.getNRAgent();
 const HC = require('./health-check');
 const LogMessage = require('./LogMessage');
 const commonUtils = require('./commonUtils');
 
-const statusUtils = require('./statusUtils');
+const appInfo = require('./applicationinfo').getInstance();
 
 let firstEventSent = false;
+let appDir = EMPTY_STR;
 
 const events = require('events');
 const eventEmitter = undefined;
@@ -27,6 +28,20 @@ let logger = logs.getLogger();
 const initLogger = logs.getInitLogger();
 
 const NODE_SER = 'node-serialize/lib/serialize.js';
+const SECURE_COOKIE = 'SECURE_COOKIE';
+
+const insecureSettingApiIdSet = new Set();
+
+/**
+ * Utility to remove insecureSettingAPIIds after 30 mins from the set.
+ * @param {*} entry 
+ */
+function addInsecureSettingApiId(entry) {
+    insecureSettingApiIdSet.add(entry);
+    setTimeout(() => {
+        insecureSettingApiIdSet.delete(entry);
+    }, 30 * 60 * 1000);
+}
 
 function getSecEventEmitter() {
     if (eventEmitter) {
@@ -68,6 +83,7 @@ const sleep = (timeout) => new Promise((resolve) => {
 function generateSecEvent(securityMetadata) {
     const traceObject = securityMetadata.traceObject;
     const request = securityMetadata.request;
+    let appServerInfo = {};
 
     if (request && request.headers[NR_CSEC_FUZZ_REQUEST_ID]) {
         HC.getInstance().iastEventStats.processed++;
@@ -75,6 +91,16 @@ function generateSecEvent(securityMetadata) {
     else {
         HC.getInstance().raspEventStats.processed++;
     }
+
+    try {
+        appDir = appInfo.serverInfo.deployedApplications[0].deployedPath;
+        appServerInfo.applicationDirectory = appDir;
+        appServerInfo.serverBaseDirectory = appDir;
+        appServerInfo.connectionConfiguration = { [request.serverPort]: request.protocol };
+
+    } catch (error) {
+    }
+
     try {
         let stakTrace = traceObject.stacktrace;
         let uri = EMPTY_STR;
@@ -84,8 +110,15 @@ function generateSecEvent(securityMetadata) {
 
         let apiId = shaUtil.getSHA256ForData(traceObject.stacktrace.join('|') + uri);
         apiId = securityMetadata.eventType + HYPHEN + apiId;
+        if (securityMetadata.eventType == SECURE_COOKIE) {
+            if (insecureSettingApiIdSet.has(apiId)) {
+                return;
+            }
+            addInsecureSettingApiId(apiId);
+        }
         const agentModule = Agent.getAgent();
         const metaData = {};
+        metaData.appServerInfo = appServerInfo;
         if (traceObject.sourceDetails && traceObject.sourceDetails.evalObj) {
             metaData.triggerViaRCI = true;
             metaData.rciMethodsCalls = traceObject.sourceDetails.evalObj.invokedCalls;
@@ -104,7 +137,6 @@ function generateSecEvent(securityMetadata) {
         event.httpRequest.route = uri;
         return event;
     } catch (e) {
-        statusUtils.addErrortoBuffer(e);
         logger.error("Error in generating event:", e);
 
         const logMessage = new LogMessage.logMessage(SEVERE, 'Error while generating event', __filename, e);

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

@@ -25,7 +25,6 @@ const {
 } = require('./connections/websocket');
 const { HC_INTERVAL_MS } = require('../../resources/config');
 const { LOG_DIR, EXITEVENT, JSON_NAME } = require('./sec-agent-constants');
-const statusUtils = require('./statusUtils');
 const njsAgentConstants = require('./sec-agent-constants');
 
 let wsInstance;
@@ -120,6 +119,10 @@ const sendHC = async function () {
         json = JSON.parse(json);
         json.policyVersion = applicationInfo.policyVersion;
         json.entityGuid = applicationInfo.entityGuid;
+        if (NRAgent && NRAgent.config) {
+            json.appEntityGuid = NRAgent.config.entity_guid;
+            json.appAccountId = NRAgent.config.account_id;
+        }
 
         try {
             json.stats = await commonUtils.getHCStats();
@@ -131,7 +134,6 @@ const sendHC = async function () {
         json.serviceStatus.websocket = commonUtils.getWSHealthStatus();
         json.serviceStatus.logWriter = await commonUtils.isLogAccessible(`${LOG_DIR}node-security-collector.log`);
         json.serviceStatus.initLogWriter = await commonUtils.isLogAccessible(`${LOG_DIR}node-security-collector-init.log`);
-        json.serviceStatus.statusLogWriter = await commonUtils.isLogAccessible(njsAgentConstants.STATUS_LOG_FILE);
         json.serviceStatus.agentActiveStat = commonUtils.isAgentActiveState();
         json.serviceStatus.iastRestClient = commonUtils.iastRestClientStatus();
 
@@ -148,8 +150,6 @@ const sendHC = async function () {
         hc.getInstance().resetEventStats();
 
         logger.info('Health Check Status:', JSON.stringify(json));
-        statusUtils.addHCtoBuffer(json);
-        statusUtils.writeSnapshot();
         getDispatcherAndSendEvent(json);
     }
 };

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "New Relic Security Agent for Node.js",
   "main": "index.js",
-  "jsonVersion": "1.2.3",
+  "jsonVersion": "1.2.5",
   "contributors": [
     {
       "name": "Sumit Suthar",
       "email": "ssuthar@newrelic.com",
-      "web": "http://newrelic.com"
+      "web": "https://newrelic.com"
     },
     {
       "name": "Pratik Gunjetiya",
       "email": "pgunjetiya@newrelic.com",
-      "web": "http://newrelic.com"
+      "web": "https://newrelic.com"
     }
   ],
   "scripts": {
@@ -28,6 +28,10 @@
     "New Relic Security Agent",
     "Node.js Application Security"
   ],
+  "engines": {
+    "node": ">=18",
+    "npm": ">=6.0.0"
+  },
   "author": "newrelic",
   "license": "New Relic Software License v1.0",
   "repository": {
@@ -35,13 +39,14 @@
     "url": "https://github.com/newrelic/csec-node-agent.git"
   },
   "dependencies": {
-    "axios": "^1.6.8",
+    "axios": "^1.7.4",
     "check-disk-space": "^3.4.0",
     "content-type": "^1.0.5",
     "fast-safe-stringify": "^2.1.1",
     "find-package-json": "^1.2.0",
     "hash.js": "^1.1.7",
     "html-entities": "^2.3.6",
+    "https-proxy-agent": "^7.0.4",
     "is-invalid-path": "^1.0.2",
     "js-yaml": "^4.1.0",
     "jsonschema": "^1.4.1",

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

@@ -1,165 +0,0 @@
-/*
- * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Software License v1.0
- */
-
-/* eslint-disable new-cap */
-
-const njsAgentConstants = require('./sec-agent-constants');
-const agentConfig = require('../../resources/config');
-const { AGENT_DIR } = agentConfig;
-const lodash = require('lodash');
-
-let errors = [];
-
-const ringBuffer = require('ringbufferjs');
-const bufferedHC = new ringBuffer(5);
-const bufferedErrors = new ringBuffer(5);
-const fs = require('fs');
-const util = require('util');
-let HC = [];
-let lastHC = {};
-const logs = require('./logging');
-const commonUtils = require('./commonUtils');
-const logger = logs.getLogger();
-const statusFile = njsAgentConstants.STATUS_LOG_FILE;
-const sep = require('path').sep;
-
-const statusTemplate = 'Snapshot timestamp: : %s\n' +
-    `CSEC Agent start timestamp: ${njsAgentConstants.AGENT_START_TIME} with application uuid:${commonUtils.getUUID()}\n` +
-    `CSEC_HOME: ${njsAgentConstants.CSEC_HOME}${sep}nr-security-home${sep}\n` +
-    `Agent location: ${AGENT_DIR}\n` +
-    `Using CSEC Agent for Node.js, Node version:${process.version}, PID:${process.pid}\n` +
-    `Process title: ${process.title}\n` +
-    `Process binary: ${process.execPath}\n` +
-    'Application location: %s\n' +
-    `Current working directory: ${process.cwd()}\n` +
-    `Agent mode: ${commonUtils.getCSECmode()}\n` +
-    'Application server: %s\n' +
-    `Application Framework: %s\n` +
-    `Websocket connection to Prevent Web: ${commonUtils.getValidatorServiceEndpointURL()}, Status: %s\n` +
-    'Instrumentation successful\n' +
-    'Tracking loaded modules in the application\n' +
-    'Policy applied successfully. Policy version is: %s\n' +
-    'Started Health Check for Agent\n' +
-    'Started Inbound and Outbound monitoring \n' +
-    '\nProcess stats:\n%s\n' +
-    '\nService stats:\n%s\n' +
-    '\nLast 5 errors: \n%s\n' +
-    '\nLast 5 Health Checks are:\n %s \n';
-
-/**
- * Utility to add hc in hc buffer
- * @param {*} healthCheck
- */
-function addHCtoBuffer(healthCheck) {
-    try {
-        bufferedHC.enq(healthCheck);
-        lastHC = healthCheck;
-    } catch (error) {
-        logger.debug(error);
-    }
-}
-
-/**
- * Utility to add error object in error buffer
- * @param {*} error
- */
-function addErrortoBuffer(error) {
-    try {
-        let errorObj = {
-            'error': error.stack
-        }
-        bufferedErrors.enq(errorObj);
-    } catch (error) {
-        logger.debug(error);
-    }
-}
-
-/**
- * utility to format status template with dynamic values
- */
-function getFormattedData() {
-    const Agent = require('./agent').Agent.getAgent();
-    const appInfo = Agent.applicationInfo;
-    const deployedApplications = appInfo && appInfo.serverInfo && appInfo.serverInfo.deployedApplications;
-    const appLoc = deployedApplications[0].deployedPath;
-    const formattedSnapshot = util.format(statusTemplate, new Date().toString(), appLoc, appInfo.serverInfo.name, commonUtils.getFramework(), commonUtils.getWSHealthStatus(), appInfo.policyVersion, getKeyValPairs(lastHC.stats), getKeyValPairs(lastHC.serviceStatus), JSON.stringify(getBufferedErrors()), JSON.stringify(getBufferedHC()));
-    return formattedSnapshot;
-}
-
-/**
- * utility to write snapshot in snapshot file
- */
-function writeSnapshot() {
-    const snapshot = getFormattedData();
-    commonUtils.removeOlderSnapshots();
-    fs.writeFile(statusFile, snapshot, { mode: 0o660 }, function (err) {
-        if (err) {
-            logger.debug(err.message);
-            const LogMessage = require('./LogMessage');
-            const logMessage = new LogMessage.logMessage("DEBUG", 'Error in creating snapshot file', __filename, err);
-            commonUtils.addLogEventtoBuffer(logMessage);
-        } else {
-            logger.info('Snapshot updated to file: %s', statusFile);
-            fs.chmod(statusFile, 0o660, (err) => {
-                if (err) {
-                    addErrortoBuffer(err);
-                }
-            });
-        }
-    });
-}
-/**
- * return buffered error instance.
- */
-function getRingBufferedErrors() {
-    return bufferedErrors;
-}
-
-/**
- * return buffered HC list without null, undefined
- */
-function getBufferedHC() {
-    try {
-        HC = lodash.compact(bufferedHC._elements);
-    } catch (error) {
-        logger.debug(error);
-    }
-
-    return HC;
-}
-/**
- * returns buffered error list without null, undefined
- */
-function getBufferedErrors() {
-    try {
-        errors = lodash.compact(bufferedErrors._elements);
-    } catch (error) {
-        logger.debug(error);
-    }
-    return errors;
-}
-
-/**
- * Utility to get key val pairs from json object
- * @param {*} jsonObject
- */
-function getKeyValPairs(jsonObject) {
-    let statStr = njsAgentConstants.EMPTY_STR;
-    for (const key in jsonObject) {
-        statStr = statStr + key + ': ' + jsonObject[key] + '\n';
-    }
-    return statStr;
-}
-
-module.exports = {
-    statusTemplate,
-    addHCtoBuffer,
-    getFormattedData,
-    writeSnapshot,
-    addErrortoBuffer,
-    getRingBufferedErrors,
-    getBufferedHC,
-    getBufferedErrors
-};