@newrelic/security-agent 2.0.0 → 2.1.0

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

@@ -70,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);
 
@@ -103,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.
  */
@@ -143,12 +156,17 @@ 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));
         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,9 +1,9 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "New Relic Security Agent for Node.js",
   "main": "index.js",
-  "jsonVersion": "1.2.5",
+  "jsonVersion": "1.2.9",
   "contributors": [
     {
       "name": "Sumit Suthar",
@@ -42,6 +42,7 @@
     "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",