@newrelic/security-agent 1.5.0 → 2.1.0

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

@@ -14,7 +14,8 @@ const NODE_JS_LITERAL = 'Node.js:';
 
 let NODE_SERVER;
 let instance;
-let logger;
+const logs = require('./logging');
+const logger = logs.getLogger();
 const API = require('../../../nr-security-api');
 const NRAgent = API.getNRAgent();
 
@@ -35,6 +36,7 @@ module.exports.getInstance = function () {
     return instance;
 };
 
+
 /**
  * Creates a new HealthCheck object.
  *
@@ -46,7 +48,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;
@@ -62,6 +65,9 @@ function HC(info) {
     this.iastEventStats = EventStats.getInstance();
     this.raspEventStats = EventStats.getInstance();
     this.exitEventStats = EventStats.getInstance();
+    this.scanStartTime =  require('./commonUtils').scanStartTime;
+    this.trafficStartedTime = require('./commonUtils').trafficStartedTime;
+    this.procStartTime = Date.now() - Math.floor(process.uptime() * 1000);
 
 
     /**

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;
@@ -101,10 +134,10 @@ function generateSecEvent(securityMetadata) {
         const isAPIBlocked = false;
         const event = new SecEvent(traceObject.sourceDetails.fileName, traceObject.sourceDetails.funcName, traceObject.sourceDetails.lineNumber, securityMetadata.interceptedArgs, securityMetadata.executionId, agentModule.applicationInfo, securityMetadata.request, securityMetadata.eventType, traceObject.sourceDetails.source, securityMetadata.eventCategory, metaData, stakTrace, apiId, isAPIBlocked);
         event.metaData.isClientDetectedFromXFF = isClientDetectedFromXFF;
+        event.metaData.skipScanParameters = NRAgent.config.security.exclude_from_iast_scan.http_request_parameters;
         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);
@@ -159,9 +192,12 @@ function generateExitEvent(secEvent) {
 
 function sendEvent(secEvent) {
     const agentModule = Agent.getAgent();
-    if (agentModule.status.getStatus() != 'connecting' && NRAgent.config.security.enabled) {
+    if (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){
+                commonUtils.trafficStartedTime = Date.now();
+            }
             initLogger.info("[STEP-8] => First event sent for validation. Security Agent started successfully", JSON.stringify(secEvent));
             firstEventSent = true;
         }

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;
@@ -71,22 +70,22 @@ const initialize = function () {
         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));
+            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);
             require('../core/ExceptionReporting').startExceptionSendingSchedular();
         } catch (error) {
-            logger.debug("Error while processing API endpoints",error);
+            logger.debug("Error while processing API endpoints", error);
         }
-       
+
         try {
             const framework = NRAgent.environment.get('Framework')[0];
             const dispatcher = NRAgent.environment.get('Dispatcher')[0];
             const logMessage = new LogMessage.logMessage("INFO", `Detected framework: ${framework} and dispatcher: ${dispatcher}`, __filename, null);
             commonUtils.addLogEventtoBuffer(logMessage);
         } catch (error) {
-            logger.debug("Error while extracting data from APM environment",error);
+            logger.debug("Error while extracting data from APM environment", error);
         }
     }, 20000);
 
@@ -104,13 +103,26 @@ function initializeInMainThread() {
         const validatorService = commonUtils.getValidatorServiceEndpointURL();
         wsInstance = new SecWebSocket(validatorService, {}, logger);
         dispatcher = function dispatcher(message) {
-            wsInstance.dispatch(message);
+            if (Agent.getAgent().status.getStatus() == 'active') {
+                wsInstance.dispatch(message);
+            }
         };
     } else {
         return wsInstance;
     }
 }
 
+function getTestIdentifier() {
+    try {
+        let authHeaders = require('./Auth-headers').getInstance();
+        let testIdentifer = authHeaders['NR-CSEC-IAST-TEST-IDENTIFIER'] ? authHeaders['NR-CSEC-IAST-TEST-IDENTIFIER'] : '';
+        return testIdentifer
+    } catch (error) {
+        logger.debug("unable to get test identifier", error);
+    }
+
+}
+
 /**
  * Sends Agent HelthCheck to Validator.
  */
@@ -120,6 +132,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 +147,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();
 
@@ -141,15 +156,18 @@ const sendHC = async function () {
         json.eventSendRejectionCount = json.eventRejectionCount;
         json.eventSendErrorCount = json.eventProcessingErrorCount;
 
+        json.scanStartTime = commonUtils.scanStartTime;
+        json.trafficStartedTime = commonUtils.trafficStartedTime;
+        json.iastTestIdentifer = getTestIdentifier();
+
         hc.getInstance().resetDropCount();
         hc.getInstance().resetProcessedCount();
         hc.getInstance().resetEventSentCount();
         hc.getInstance().resetHttpRequestCount();
         hc.getInstance().resetEventStats();
 
+
         logger.info('Health Check Status:', JSON.stringify(json));
-        statusUtils.addHCtoBuffer(json);
-        statusUtils.writeSnapshot();
         getDispatcherAndSendEvent(json);
     }
 };
@@ -190,9 +208,14 @@ function obeyReconnect() {
     wsInstance.obeyReconnect();
 }
 
+function closeWS() {
+    wsInstance.closeWS();
+}
+
 module.exports = {
     initialize,
     write: sendEvent,
     dispatcher: getDispatcherAndSendEvent,
-    obeyReconnect
+    obeyReconnect,
+    closeWS
 };

package/lib/nr-security-api/index.js

@@ -10,7 +10,39 @@ let NRAgent;
  * 
  * @returns NewRelic Agent instance
  */
-function getNRAgent(){
+function getNRAgent() {
+    if (NRAgent && NRAgent.config && !NRAgent.config.security.scan_schedule) {
+        NRAgent.config.security.scan_schedule = {};
+        NRAgent.config.security.scan_schedule.delay = 0;
+        NRAgent.config.security.scan_schedule.duration = 0;
+        NRAgent.config.security.scan_schedule.schedule = '';
+        NRAgent.config.security.scan_schedule.always_sample_traces = false;
+
+    }
+    if ( NRAgent && NRAgent.config && !NRAgent.config.security.scan_controllers) {
+        NRAgent.config.security.scan_controllers = {};
+        NRAgent.config.security.scan_controllers.iast_scan_request_rate_limit = 3600;
+        NRAgent.config.security.scan_controllers.scan_instance_count = 0;
+    }
+    if (NRAgent && NRAgent.config && !NRAgent.config.security.exclude_from_iast_scan) {
+        NRAgent.config.security.exclude_from_iast_scan = {};
+        NRAgent.config.security.exclude_from_iast_scan.api = [];
+        NRAgent.config.security.exclude_from_iast_scan.http_request_parameters = {};
+        NRAgent.config.security.exclude_from_iast_scan.http_request_parameters.header = [];
+        NRAgent.config.security.exclude_from_iast_scan.http_request_parameters.query = [];
+        NRAgent.config.security.exclude_from_iast_scan.http_request_parameters.body = [];
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category = {};
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.insecure_settings = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.invalid_file_access = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.sql_injection = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.nosql_injection = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.ldap_injection = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.javascript_injection = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.command_injection = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.xpath_injection = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.ssrf = false;
+        NRAgent.config.security.exclude_from_iast_scan.iast_detection_category.rxss = false;
+    }
     return NRAgent;
 }
 
@@ -18,7 +50,7 @@ function getNRAgent(){
  * API to set newrelic agent object.
  * @param {*} agent 
  */
-function setNRAgent(agent){
+function setNRAgent(agent) {
     NRAgent = agent;
 }
 
@@ -26,11 +58,11 @@ function setNRAgent(agent){
  * API to get security agent
  * @returns Security Agent instanace
  */
-function getSecAgent(){
+function getSecAgent() {
     const Agent = require('../nr-security-agent/lib/core/agent').Agent;
     const csecAgent = Agent.getAgent();
-    if(csecAgent){
-         return csecAgent;
+    if (csecAgent) {
+        return csecAgent;
     }
 }
 
@@ -38,11 +70,11 @@ function getSecAgent(){
  * API to get status of security agent
  * @returns Security Agent status
  */
-function getSecAgentStatus(){
+function getSecAgentStatus() {
     const Agent = require('../nr-security-agent/lib/core/agent').Agent;
-    if(Agent.getAgent()){
+    if (Agent.getAgent()) {
         return Agent.getAgent().status.getStatus()
-   }
+    }
 }
 
 /**
@@ -50,15 +82,15 @@ function getSecAgentStatus(){
  * @param {*} securityMetadata 
  * @returns security event object
  */
-function generateSecEvent(securityMetadata){
-   return require('../nr-security-agent/lib/core/sec-util').generateSecEvent(securityMetadata);
+function generateSecEvent(securityMetadata) {
+    return require('../nr-security-agent/lib/core/sec-util').generateSecEvent(securityMetadata);
 }
 
 /**
  * API to send security event 
  * @param {*} secEvent 
  */
-function sendEvent(secEvent){
+function sendEvent(secEvent) {
     require('../nr-security-agent/lib/core/sec-util').sendEvent(secEvent);
 }
 
@@ -66,7 +98,7 @@ function sendEvent(secEvent){
  * API to get logger instance
  * @returns 
  */
-function getLogger(){
+function getLogger() {
     return require('../nr-security-agent/lib/core/logging').getLogger();
 }
 /**
@@ -76,7 +108,7 @@ function getLogger(){
  * @param {*} responseHeaders 
  * @returns 
  */
-function checkForReflectedXSS(secRequest, responseBody, responseHeaders){
+function checkForReflectedXSS(secRequest, responseBody, responseHeaders) {
     return require('../nr-security-agent/lib/core/xss-utils').checkForReflectedXSS(secRequest, responseBody, responseHeaders);
 }
 
@@ -84,7 +116,7 @@ function checkForReflectedXSS(secRequest, responseBody, responseHeaders){
  * API to get security agent policy
  * @returns security agent policy
  */
-function getPolicy(){
+function getPolicy() {
     return require('../nr-security-agent/lib/core/Policy').getInstance();
 }
 
@@ -92,7 +124,7 @@ function getPolicy(){
  * API to generate Exit event
  * @param {*} event 
  */
-function generateExitEvent(event){
+function generateExitEvent(event) {
     require('../nr-security-agent/lib/core/sec-util').generateExitEvent(event);
 }
 

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "1.5.0",
+  "version": "2.1.0",
   "description": "New Relic Security Agent for Node.js",
   "main": "index.js",
-  "jsonVersion": "1.2.3",
+  "jsonVersion": "1.2.9",
   "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": {
@@ -38,10 +42,12 @@
     "axios": "^1.7.4",
     "check-disk-space": "^3.4.0",
     "content-type": "^1.0.5",
+    "cron": "^3.1.7",
     "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
-};