@newrelic/security-agent 0.0.4 → 0.0.5

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+### v0.0.5
+* Updated README file
+* Init logging update
+* Code refactoring
+* Minor bug fixes

package/README.md

@@ -1,4 +1,7 @@
+<a href="https://opensource.newrelic.com/oss-category/#community-plus"><picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png"><source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"><img alt="New Relic Open Source community plus project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"></picture></a>
+
 # New Relic Node.js security agent
+[![npm status badge][1]][2] [![Security Agent CI][3]][4]
 
 **Note**: The IAST capability should only be used in pre-production environments as the application is tested for real exploitable vulnerabilities.
 
@@ -40,6 +43,9 @@ The `@newrelic/security-agent` must be explicitly enabled in order to perform IA
 
 The [Developer docs](http://newrelic.github.io/node-newrelic/) for writing instrumentation will be of help. We particularly recommend the [tutorials](https://newrelic.github.io/node-newrelic/tutorial-Instrumentation-Basics.html) and the [shim API](https://newrelic.github.io/node-newrelic/Shim.html) documentation.
 
+### Supported  Node.js Versions
+- Node version 14.x and above
+
 ### Supported  Modules
 
 - Node.js core modules
@@ -95,4 +101,9 @@ If you would like to contribute to this project, review [these guidelines](https
 
 ## License
 The New Relic security agent is licensed under the New Relic Pre-Release Software Notice.
-The `@newrelic/security-agent` also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.
+The `@newrelic/security-agent` also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.
+
+[1]: https://img.shields.io/npm/v/@newrelic/security-agent.svg 
+[2]: https://www.npmjs.com/package/@newrelic/security-agent 
+[3]: https://github.com/newrelic/csec-node-agent/workflows/CSEC%20Node%20Agent%20CI/badge.svg
+[4]: https://github.com/newrelic/csec-node-agent/actions?query=workflow%3A%22CSEC+Node+Agent+CI%22

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

@@ -48,7 +48,6 @@ function extractApplicationDefForLambda(applications) {
  * @param {*} applications
  */
 function extractApplicationDef(execArgs, applications) {
-    initLogger.info(LOG_MESSAGES.DEP_APP_GATHERING_STARTED);
     if (IS_LAMBDA_ENV) {
         return extractApplicationDefForLambda(applications);
     }
@@ -93,6 +92,7 @@ function extractApplicationDef(execArgs, applications) {
  * Initialize the Agent.
  */
 function initialize() {
+    initLogger.info("[STEP-1] => Security Agent is starting")
     const policyManager = require('./lib/core/Policy');
     policyManager.setDefaultPolicy();
     commonUtils.initialSetup();
@@ -103,7 +103,7 @@ function initialize() {
     // Initialize ApplicationInfo
     const applicationInfo = applicationInfoModule.getInstance();
     applicationInfoModule.setBuildDetails(AGENT_DIR, applicationInfo);
-
+    initLogger.info("[STEP-3] => Gathering information about the application :", JSON.stringify(applicationInfo));
     if (NRAgent) {
         NRAgent.on('started', () => {
             if (NRAgent.config.security.enabled) {
@@ -118,7 +118,6 @@ function initialize() {
         });
     }
 
-    initLogger.info(LOG_MESSAGES.APP_INFO_GATHERING_STARTED);
 
     // Fallback extract with process.argv in case application is not detected using proc cmdline
     if ((extractApplicationDef(getProcCMDLineSanitized(applicationInfoModule), applications) || extractApplicationDef(process.argv, applications)) &&
@@ -131,10 +130,10 @@ function initialize() {
                 return false;
             }
         }
-        initLogger.info(LOG_MESSAGES.COLLECTOR_INFO, applicationInfo.collectorVersion, applicationInfo.jsonVersion, applicationInfo.buildNumber);
+        logger.info(LOG_MESSAGES.AGENT_INFO, applicationInfo.collectorVersion, applicationInfo.jsonVersion);
+        
         applicationInfoModule.addProperty('serverInfo.deployedApplications', applications);
-        initLogger.info(LOG_MESSAGES.APP_INFO_DEP_APP, JSON.stringify(applications));
-
+        
         shaSizeUtil.setLogger(logger);
 
         // Initialize Agent Status
@@ -142,8 +141,6 @@ function initialize() {
 
         // Initialize
         Agent.init(applicationInfo, logger, wsClient, status);
-        initLogger.info(LOG_MESSAGES.AGENT_INIT_SUCCESSFUL, applicationInfo.pid, applicationInfo.applicationUUID);
-        initLogger.info(LOG_MESSAGES.AGENT_INIT_SUCCESSFUL_COMPLETE, applicationInfo.pid, applicationInfo.applicationUUID);
         logger.info('Security Agent attached with application, with applicationUUID: %s', applicationInfo.applicationUUID);
     } else {
         // Do not load the agent.
@@ -164,5 +161,6 @@ function getProcCMDLineSanitized(applicationInfoModule) {
 (() => {
     if (initialize()) {
         require('../instrumentation-security');
+        initLogger.info("[STEP-6] => Application instrumentation applied successfully");
     }
 })();

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

@@ -21,15 +21,15 @@ function AuthHeaders() {
         const NRAgent = API.getNRAgent();
         authHeaders = {}
         authHeaders['NR-CSEC-CONNECTION-TYPE'] = 'LANGUAGE_COLLECTOR';
-        authHeaders['NR-AGENT-RUN-TOKEN'] = process.env.agent_run_id || NRAgent.config.run_id;
-        const COLLECTOR_VERSION = process.env.collectorVersion || appInfo.collectorVersion || '';
+        authHeaders['NR-AGENT-RUN-TOKEN'] =  NRAgent.config.run_id;
+        const COLLECTOR_VERSION = appInfo.collectorVersion || '';
         authHeaders['NR-CSEC-VERSION'] = COLLECTOR_VERSION.trim();
         authHeaders['NR-CSEC-COLLECTOR-TYPE'] = 'NODE';
         authHeaders['NR-CSEC-MODE'] = commonUtils.getCSECmode();
         authHeaders['NR-CSEC-APP-UUID'] = commonUtils.getUUID();
-        authHeaders['NR-CSEC-JSON-VERSION'] = process.env.jsonVersion || appInfo.jsonVersion;
-        authHeaders['NR-CSEC-BUILD-NUMBER'] = process.env.buildNumber || appInfo.buildNumber;
-        authHeaders['NR-ACCOUNT-ID'] = process.env.account_id || NRAgent.config.account_id;
+        authHeaders['NR-CSEC-JSON-VERSION'] = appInfo.jsonVersion;
+        authHeaders['NR-CSEC-BUILD-NUMBER'] = appInfo.buildNumber;
+        authHeaders['NR-ACCOUNT-ID'] =  NRAgent.config.account_id;
         authHeaders['NR-LICENSE-KEY'] = NRAgent ? NRAgent.config.license_key : '';
     } catch (error) {
         logger.error("Exception in preparing auth headers:", error);
@@ -48,7 +48,6 @@ AuthHeaders.prototype.constructor = AuthHeaders;
 function getInstance() {
     if (!authHeaders) {
         authHeaders = new AuthHeaders();
-        initLogger.info("[STEP-2][BEGIN][Auth-Headers]: Authentication Headers Created Successfully");
     }
     return authHeaders;
 }

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

@@ -50,7 +50,7 @@ function setPolicyData(data) {
     if (policy.data.version !== data.version) {
         policy.data = data;
         appInfoVersionUpdate(policy, data);
-        initLogger.info(LOG_MESSAGES.POLICY_APPLIED, JSON.stringify(policy.data));
+        initLogger.info("[STEP-7] => Received and applied policy/configuration", JSON.stringify(policy.data));
         logger.info('Applied policy is:', JSON.stringify(policy.data));
         if (NRAgent && NRAgent.config.security.detection) {
             logger.info('Security detection flags:', JSON.stringify(NRAgent.config.security.detection));

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

@@ -61,8 +61,6 @@ Agent.prototype.setApplicationInfo = function setApplicationInfo(applicationInfo
 
         Agent.eventEmitter.emit(EVENTS.APPLICATION_INFO_UPDATE_EVENT, applicationInfoObject);
         const logs = require('./logging');
-        const initLogger = logs.getInitLogger();
-        initLogger.info(LOG_MESSAGES.INIT_APPINFO_SEND, JSON.stringify(applicationInfoObject));
 
     }
 
@@ -129,8 +127,6 @@ Agent.getAgent = function getAgent() {
 Agent.setNRAgent = function setNRAgent(agent) {
     if (agent) {
         NRAgent = agent;
-        process.env.account_id = NRAgent.config.account_id;
-        process.env.agent_run_id = NRAgent.config.run_id; 
     }
     const CSECAgent = Agent.getAgent();
     if (CSECAgent) {

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

@@ -214,7 +214,6 @@ ApplicationInfo.prototype.updateSHAAndSize = async function updateSHAAndSize (Gl
     // emit finalization of application info
     if (Agent.getAgent()) {
         Agent.getAgent().setApplicationInfo(applicationInfo);
-        initLogger.info(LOG_MESSAGES.APP_INFO_GENERATED, JSON.stringify(applicationInfo));
     }
 };
 
@@ -426,12 +425,9 @@ function getProcStartTime () {
 function setBuildDetails (agentDir, applicationInfo) {
     const jsonFileHandler = new JsonHandler(PACKAGE_JSON_FILE, agentDir);
     const pkg = jsonFileHandler.getJSON();
-    process.env.collectorVersion = pkg.collectorVersion;
-    applicationInfo.collectorVersion = pkg.collectorVersion;
+    applicationInfo.collectorVersion = pkg.version;
     applicationInfo.jsonVersion = pkg.jsonVersion;
-    applicationInfo.buildNumber = pkg.buildNumber;
-    process.env.buildNumber = pkg.buildNumber;
-    process.env.jsonVersion = applicationInfo.jsonVersion;
+    applicationInfo.buildNumber = pkg.version;
 }
 
 function isK8S () {

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

@@ -384,7 +384,7 @@ function getCSECmode(){
  * @returns 
  */
 function getPathOfCACert(){
-    const certPath = NRAgent && NRAgent.config.security.ca_bundle_path ? NRAgent.config.security.ca_bundle_path : path.resolve(__dirname, '../../resources/cert.pem');
+    const certPath = process.env.NEW_RELIC_SECURITY_CA_BUNDLE_PATH ? process.env.NEW_RELIC_SECURITY_CA_BUNDLE_PATH : path.resolve(__dirname, '../../resources/cert.pem');
     return certPath
 }
 

package/lib/nr-security-agent/lib/core/connections/websocket/response/startup-handshake-handler.js

@@ -15,8 +15,8 @@ module.exports.handler = function handler(json) {
         const startupConfig = StartupConfig.getInstance();
         startupConfig.config = json.data;
       
-        initLogger.info(LOG_MESSAGES.COLLECTOR_INIT_WITH_PROP, JSON.stringify(startupConfig.config));
-        initLogger.info('Collector is now ACTIVE for', applicationInfoModule.getInstance().applicationUUID);
+        initLogger.info(LOG_MESSAGES.AGENT_INIT_WITH_PROP, JSON.stringify(startupConfig.config));
+        initLogger.info('Security Agent is now ACTIVE for', applicationInfoModule.getInstance().applicationUUID);
 
     } catch (error) {
         logger.error(LOG_MESSAGES.PARSING_EXP_WELCOME_MSG, error);

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

@@ -98,7 +98,7 @@ SecWebSocket.prototype.init = function init() {
     this.setValidatorNotReadyForEvents();
     const validatorService = commonUtils.getValidatorServiceEndpointURL();
     const authHeaders = require('../../Auth-headers').getInstance();
-    initLogger.info(`[STEP-4][BEGIN][WS] Connecting to Prevent-Web service at ${validatorService}`);
+    initLogger.info(`Connecting to Validator at ${validatorService}`);
     let cert = ''
     try {
         const certPath = commonUtils.getPathOfCACert();
@@ -311,15 +311,14 @@ const defaultOnOpenCB = () => async function onOpen() {
     pingIntervalConst = setInterval(() => {
         self.pingWS();
     }, 30000)
-
+    const validatorService = commonUtils.getValidatorServiceEndpointURL();
+    initLogger.info(`[STEP-4] => Web socket connection to SaaS validator established successfully at ${validatorService}`)
     try {
-        initLogger.info(LOG_MESSAGES.WS_CONNECTED);
 
         this.wsRetryCount = 0;
         process.env.WS_HEALTH = 'OK';
 
         const applicationInfo = APP_INFO || Agent.getAgent().applicationInfo;
-        initLogger.info(LOG_MESSAGES.SENDING_APPINFO, JSON.stringify(applicationInfo));
         await self.dispatchApplicationInfo(applicationInfo);
 
         // by now we expect IC to be ready
@@ -329,7 +328,7 @@ const defaultOnOpenCB = () => async function onOpen() {
         await self.flushEventQueue();
         ResponseHandler.FuzzRequestHandler.setLastFuzzEnventTime();
         releaseWebSocket();
-        initLogger.info(LOG_MESSAGES.SENDING_APPINFO_COMPLETE, JSON.stringify(applicationInfo));
+        initLogger.info(LOG_MESSAGES.SENDING_APPINFO_COMPLETE, JSON.stringify(applicationInfo)); 
     } catch (err) {
         logger.error(`Connection broken: ${err.message}`);
         statusUtils.addErrortoBuffer(err);

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

@@ -143,6 +143,7 @@ function getLogger (applicationUUID = process.env.applicationUUID) {
         initialize(applicationUUID);
         logger = log4js.getLogger('NR_CSEC');
         const initLogger = getInitLogger();
+        initLogger.info("[STEP-2] => Generating unique identifier:",applicationUUID )
         if (NRAgent) {
             setLevel(NRAgent.config.logging.level);
         }

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

@@ -106,7 +106,7 @@ module.exports = {
 
     LOG_MESSAGES: {
         LOADED_CSEC_ENVS_MSG: '[STEP-1][COMPLETE][env] Environment Information Gathering Done.',
-        COLLECTOR_INFO: ' CSEC Node version : %s , json version : %s and build number : %s',
+        AGENT_INFO: 'Security Agent version : %s, json version : %s',
         APP_INFO_GATHERING_STARTED: '[STEP-1][BEGIN][APP_INFO] Gathering Application Info For Current Process.',
         DEP_APP_GATHERING_STARTED: '[BEGIN][APP_INFO][DEPLOYED_APP] Gathering deployed application info for current process',
         APP_INFO_DEP_APP: '[APP_INFO][DEPLOYED_APP] Deployed application info generated :%s',
@@ -140,24 +140,24 @@ module.exports = {
         UPDATE_POL_SENT_SERVER: 'Updated Policy Sent To Prevent Web',
         EXP_RAISE_POL: 'Exception Raised In Policy Validation:',
         FALLBACK_TO_CURR_POLICY: 'Fallback To Current Policy!!!:%s',
-        POLICY_APPLIED: '[STEP-7][COMPLETE][POLICY] Policy Applied :',
+        POLICY_APPLIED: 'Received and applied policy/configuration :',
         POL_PULL_INT_IS: 'Policy Pull Interval Is:',
         LOG_LEVEL_UPDATED: 'Log Level Updated To:',
         DEFAULT_POL_SET: 'Default Policy Has Been Set :',
         UNABLE_SET_DEFAULT_POL: 'Unable To Set Default Policy',
-        COLLECTOR_INIT_WITH_PROP: 'Collector Is Initialized With Properties:',
+        AGENT_INIT_WITH_PROP: 'Security Agent is initialized with properties:',
         PARSING_EXP_WELCOME_MSG: 'Parsing Exeception In Startup Welcome Command',
         ACCESS_BLOCKED_IP_DETECTED: 'Access By Blocked Ip Address Detected : ',
         FIRST_EVENT_INTERCEPTED: '[BEGIN][EVENT] First event intercepted',
         FIRST_EVENT_PROCESSED: '[EVENT] First event processed :',
-        FIRST_EVENT_SENT: '[STEP-8][COMPLETE][EVENT] First Event Sent For Validation',
+        FIRST_EVENT_SENT: '[STEP-8] => First event sent for validation. Security agent started successfully.',
         DETECTED_BROKEN_CONN: 'Detected Broken Connection. Will Reconnect Now!',
         MAX_WS_RETRY: 'Maximum WS Retry Limit Reached. Unable To Connect To Prevent Web Service!!!',
         EVENT_SENT: 'Event Sent:: ',
         ERROR_WHILE_SEND_EVENT: 'ERROR While Sending Event: {}',
         WS_CONNECTED: '[STEP-4][COMPLETE][WS] Connected To Prevent-web Service',
         SENDING_APPINFO: '[APP_INFO] Sending Application Info To Prevent-web Service: ',
-        SENDING_APPINFO_COMPLETE: '[COMPLETE][APP_INFO] Application info sent to Prevent-Web service : {}',
+        SENDING_APPINFO_COMPLETE: '[COMPLETE][APP_INFO] Application info sent to Prevent-Web service :',
         APPLY_INSTRUMENTATION: '[STEP-6][BEGIN][instrumentation] Applying Instrumentation',
         AVAIL_DISK: 'Available Disk Space Is: ',
         AVAIL_DISK_ERROR: 'Insufficient Disk Space Available To The Location %s Is : %s',

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

@@ -15,7 +15,6 @@ const NRAgent = API.getNRAgent();
 
 const statusUtils = require('./statusUtils');
 
-let firstEvent = false;
 let firstEventSent = false;
 
 const events = require('events');
@@ -89,20 +88,9 @@ function generateSecEvent(securityMetadata) {
             }
         }
         const isClientDetectedFromXFF = false;
-
-        if (!firstEvent) {
-            initLogger.info(LOG_MESSAGES.FIRST_EVENT_INTERCEPTED, securityMetadata.eventCategory, JSON.stringify(request));
-        }
         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;
-
-        if (!firstEvent) {
-            initLogger.info(LOG_MESSAGES.FIRST_EVENT_PROCESSED, JSON.stringify(event));
-            firstEvent = true;
-        }
-
         return event;
     } catch (e) {
         statusUtils.addErrortoBuffer(e);
@@ -148,7 +136,7 @@ function sendEvent(secEvent) {
     if (agentModule.status.getStatus() === 'active' && NRAgent.config.security.enabled) {
         agentModule.client.dispatcher(secEvent);
         if (!firstEventSent) {
-            initLogger.info(LOG_MESSAGES.FIRST_EVENT_SENT, JSON.stringify(secEvent));
+            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

@@ -85,17 +85,14 @@ const initialize = function () {
             wsInstance.reconnect();
         }
     });
-    // Initiate HC send routine in the provided hcInterval.
-    initLogger.info(LOG_MESSAGES.SCHED_SERVICE_START);
-    initLogger.info(LOG_MESSAGES.START_HC);
 
     setTimeout(() => {
         setInterval(sendHC, HC_INTERVAL_MS);
-        initLogger.info(LOG_MESSAGES.END_HC);
         sendHC();
     }, 30000);
 
     setInterval(commonUtils.logRollOver, 30000);
+    initLogger.info("[STEP-5] => Security Agent schedular started");
 };
 
 /**
@@ -247,13 +244,13 @@ const sendHC = async function () {
  */
 function getDispatcherAndSendEvent(eventJson) {
     const eventType = eventJson.jsonName;
-    if(eventType==='Event'){
+    if (eventType === 'Event') {
         hc.getInstance().registerEventProcessed();
     }
-   
+
     dispatcher(eventJson);
 
-    if(eventType==='Event'){
+    if (eventType === 'Event') {
         hc.getInstance().registerEventSent();
     }
 
@@ -316,7 +313,7 @@ function busyWaitOnWorkerThread(startTime = Date.now()) {
     }
 }
 
-function obeyReconnect(){
+function obeyReconnect() {
     if (workerSupported) {
         const reConnectMsg = new WorkerMessage(WorkerMessage.TYPE.OBEY_RECONNECT, {});
         wsWorker.postMessage(reConnectMsg);

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Newrelic Security Agent for Node.js",
   "main": "index.js",
   "collectorVersion": "1.0.1-limited-preview",
-  "buildNumber": 103,
   "jsonVersion": "1.0.1",
   "contributors": [
     {