@newrelic/security-agent 1.1.0 → 1.2.0

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 } = 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 } = require('../../core/constants');
 const ARRAY_TYPE = 'Array';
 const STRING_TYPE = 'string';
 const BUFFER_TYPE = 'Buffer';
@@ -168,27 +168,38 @@ function parseFuzzheaders(requestData, transactionId) {
     try {
       const additionalData = fuzzheaders[NR_CSEC_FUZZ_REQUEST_ID].split(CSEC_SEP);
       logger.debug('AdditionalData:', additionalData);
-      if (additionalData.length >= 7) {
-        for (let i = 6; i < additionalData.length; i++) {
-          let file = additionalData[i].trim();
-          file = file.replace(CSEC_HOME_TMP_CONST, CSEC_HOME_TMP);
-          file = path.resolve(file);
-          const parentDir = path.dirname(file);
-          if (!isInvalid(parentDir) && isPathInside(parentDir, CSEC_HOME_TMP)) {
-            try {
-              if (!fs.existsSync(parentDir)) {
-                secUtils.createPathIfNotExist(parentDir);
-              } else {
-                logger.debug(parentDir + ' Already Exists');
+      if (additionalData.length >= 8) {
+        let encryptedData = additionalData[6];
+        let hashVerifier = additionalData[7];
+        let decryptedData = secUtils.decryptData(encryptedData);
+        let verifiedHash = secUtils.hashVerifier(decryptedData, hashVerifier);
+        logger.debug("verifiedHash:", verifiedHash);
+        let filesToCreate = decryptedData.split(COMMA);
+        if (verifiedHash) {
+          logger.debug("Encrypted Data:", encryptedData);
+          logger.debug("Decrypted Data:", decryptedData)
+          logger.debug("fliesTocreate:",filesToCreate);
+          for (let i = 0; i < filesToCreate.length; i++) {
+            let file = filesToCreate[i].trim();
+            file = file.replace(CSEC_HOME_TMP_CONST, CSEC_HOME_TMP);
+            file = path.resolve(file);
+            const parentDir = path.dirname(file);
+            if (!isInvalid(parentDir) && isPathInside(parentDir, CSEC_HOME_TMP)) {
+              try {
+                if (!fs.existsSync(parentDir)) {
+                  secUtils.createPathIfNotExist(parentDir);
+                } else {
+                  logger.debug(parentDir + ' Already Exists');
+                }
+                fs.closeSync(fs.openSync(file, 'w'));
+  
+                requestData.tempFiles = [];
+                requestData.tempFiles.push(file);
+                requestManager.setRequest(transactionId, requestData);
+  
+              } catch (error) {
+                logger.debug(error);
               }
-              fs.closeSync(fs.openSync(file, 'w'));
-
-              requestData.tempFiles = [];
-              requestData.tempFiles.push(file);
-              requestManager.setRequest(transactionId, requestData);
-
-            } catch (error) {
-              logger.debug(error);
             }
           }
         }
@@ -392,7 +403,7 @@ function responseHook(resp, req, shim) {
       const dynamicScanningFlag = policy.data ? (policy.data.vulnerabilityScan?.enabled && policy.data.vulnerabilityScan.iastScan.enabled) : false;
       const type = response.getHeader(CONTENT_TYPE);
       let isUnsupportedType = isUnsupportedContentType(type);
-      
+
       if (request && (construct || dynamicScanningFlag) && !isUnsupportedType) {
         const args = [];
         args.push(construct);
@@ -400,7 +411,7 @@ function responseHook(resp, req, shim) {
         const traceObject = secUtils.getTraceObject(shim);
         const secMetadata = securityMetaData.getSecurityMetaData(request, args, traceObject, secUtils.getExecutionId(), EVENT_TYPE.REFLECTED_XSS, EVENT_CATEGORY.REFLECTED_XSS)
         const secEvent = API.generateSecEvent(secMetadata);
-        secEvent.httpResponse  = {};
+        secEvent.httpResponse = {};
         secEvent.httpResponse.contentType = response.getHeader(CONTENT_TYPE);
         API.sendEvent(secEvent);
       }

package/lib/instrumentation-security/index.js

@@ -200,55 +200,8 @@ newrelic.instrumentWebframework({
 })
 
 
-newrelic.instrument({
-  type: 'conglomerate',
-  moduleName: '@grpc/grpc-js/build/src/server',
-  isEsm: true,
-  onRequire: require('./hooks/grpc-js/nr-grpc').wrapServer,
-  onError: function intrumentErrorHandler(err) {
-    logger.error(err.message, err.stack)
-  }
-})
-
-newrelic.instrument({
-  type: 'conglomerate',
-  moduleName: '@grpc/grpc-js/build/src/make-client',
-  isEsm: true,
-  onRequire: require('./hooks/grpc-js/nr-grpc').wrapMakeClient,
-  onError: function intrumentErrorHandler(err) {
-    logger.error(err.message, err.stack)
-  }
-})
-
-newrelic.instrument({
-  type: 'conglomerate',
-  moduleName: '@grpc/grpc-js/build/src/resolving-call',
-  isEsm: true,
-  onRequire: require('./hooks/grpc-js/nr-grpc').wrapStartResolve,
-  onError: function intrumentErrorHandler(err) {
-    logger.error(err.message, err.stack)
-  }
-})
 
-newrelic.instrument({
-  type: 'conglomerate',
-  moduleName: '@grpc/grpc-js/build/src/call-stream',
-  isEsm: true,
-  onRequire: require('./hooks/grpc-js/nr-grpc').wrapStartCall,
-  onError: function intrumentErrorHandler(err) {
-    logger.error(err.message, err.stack)
-  }
-})
 
-newrelic.instrument({
-  type: 'conglomerate',
-  moduleName: '@grpc/grpc-js',
-  isEsm: true,
-  onRequire: require('./hooks/grpc-js/nr-grpc').initialize,
-  onError: function intrumentErrorHandler(err) {
-    logger.error(err.message, err.stack)
-  }
-})
 
 
 

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

@@ -51,7 +51,6 @@ function setPolicyData(data) {
         policy.data = data;
         appInfoVersionUpdate(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/commonUtils.js

@@ -12,7 +12,7 @@ const OS = require('os');
 const path = require('path');
 const checkDiskSpace = require('check-disk-space').default;
 const AgentStatus = require('../core/agent-status');
-const { CSEC_HOME, SLASH } = require('./sec-agent-constants');
+const { CSEC_HOME, SLASH, EMPTY_STR } = require('./sec-agent-constants');
 
 const njsAgentConstants = require('./sec-agent-constants');
 const API = require('../../../nr-security-api');
@@ -445,6 +445,20 @@ function addLogEventtoBuffer(logMessage) {
         logger.debug(error);
     }
 }
+/**
+ * Utility to get framework from APM
+ * @returns 
+ */
+function getFramework(){
+    let framework = EMPTY_STR;
+    try {
+        framework = NRAgent.environment.get('Framework')[0];
+    } catch (error) {
+        logger.debug("Unable to get framework");
+    }
+    return framework;
+}
+
 
 module.exports = {
     getUUID,
@@ -469,5 +483,6 @@ module.exports = {
     getWSHealthStatus,
     setWSHealthStatus,
     addLogEventtoBuffer,
-    getLogEvents
+    getLogEvents,
+    getFramework
 };

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

@@ -7,7 +7,6 @@
 const stringify = require('fast-safe-stringify');
 
 const restClient = require('../../restclient');
-const grpcClient = require('../../grpcClient');
 const { Agent } = require('../../../agent');
 const { FuzzFailEvent } = require('../../../FuzzFailEvent');
 const { CSEC_HOME_TMP, COLON, NR_CSEC_FUZZ_REQUEST_ID, SLASH, CSEC_SEP, SEVERE } = require('../../../sec-agent-constants');
@@ -21,6 +20,9 @@ const LogMessage = require('../../../LogMessage');
 require('dns').setDefaultResultOrder('ipv4first')
 const PolicyManager = require('../../../Policy');
 
+const {
+    IS_LAMBDA_ENV,
+    AWS_LAMBDA_FUNCTION_VERSION_ENV_IDENTIFIER } = require('../../../sec-agent-constants');
 const statusUtils = require('../../../statusUtils');
 
 const find = `${SLASH}{{NR_CSEC_VALIDATOR_HOME_TMP}}`;
@@ -123,16 +125,13 @@ function handler(json) {
 function handleFuzzRequest(fuzzDetails) {
     const { fuzzRequest } = fuzzDetails;
     try {
-        if (fuzzRequest.protocol == 'grpc') {
-            const config = parseGRPCRequestToFuzz(fuzzRequest);
-            config.headers['nr-csec-parent-id'] = fuzzRequest.id;
-            IASTUtil.completedRequestsMapInit(fuzzRequest.id);
-            grpcClient.fireRequest(config);
-            if (fuzzRequest.headers && fuzzRequest.headers[NR_CSEC_FUZZ_REQUEST_ID]) {
-                logScannedApiId(fuzzRequest.headers[NR_CSEC_FUZZ_REQUEST_ID], fuzzRequest.requestURI)
-            }
-
-            IASTUtil.removePendingRequestId(fuzzRequest.id);
+        if (IS_LAMBDA_ENV) {
+            const qualifiedARN = Agent.getAgent().applicationInfo.applicationUUID;
+            const splitArn = String.prototype.split.call(qualifiedARN, ':');
+            const arn = splitArn.slice(0, splitArn.length - 1).join(':');
+            const ver = process.env[AWS_LAMBDA_FUNCTION_VERSION_ENV_IDENTIFIER];
+            logger.info('Invoking Lambda:: ARN: ' + arn);
+            logger.info('Invoking Lambda:: Version: ' + ver);
 
         } else {
             const config = parseAxiosHttpRequestToFuzz(fuzzRequest);
@@ -154,6 +153,7 @@ function handleFuzzRequest(fuzzDetails) {
 
 
             logger.info('Firing http request:: URL: ' + config.url);
+
             const response = restClient.fireRequest(config);
             handleFuzzResponse(response, fuzzDetails);
         }
@@ -210,26 +210,6 @@ function parseAxiosHttpRequestToFuzz(requestObject) {
     };
 }
 
-/**
- * Parses the passed fuzz request object to
- * Axios config.
- *
- * @param {JSON} requestObject
- */
-function parseGRPCRequestToFuzz(requestObject) {
-    let serverName = requestObject.serverName ? requestObject.serverName : LOCALHOST;
-    let host = serverName + COLON + requestObject.serverPort
-    return {
-        url: requestObject.protocol + COLON_SLASH_SLASH + host + requestObject.url,
-        requestURI: requestObject.requestURI,
-        protocol: requestObject.protocol,
-        serverPort: requestObject.serverPort,
-        method: requestObject.method,
-        data: requestObject.body,
-        headers: requestObject.headers,
-        timeout: 5000,
-    };
-}
 
 
 /**

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

@@ -111,6 +111,7 @@ module.exports = {
     SEVERE: 'SEVERE',
     HIGH: 'HIGH',
     CRITICAL: 'CRITICAL',
+    HYPHEN: '-',
 
     LOG_MESSAGES: {
         LOADED_CSEC_ENVS_MSG: '[STEP-1][COMPLETE][env] Environment Information Gathering Done.',
@@ -165,7 +166,7 @@ module.exports = {
         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: '[STEP-3][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

@@ -9,7 +9,7 @@ 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 } = require('./sec-agent-constants');
+const { LOG_MESSAGES, NR_CSEC_FUZZ_REQUEST_ID, COLON, VULNERABLE, EXITEVENT, EMPTY_STR, RASP, SEVERE, HYPHEN } = require('./sec-agent-constants');
 const API = require('../../../nr-security-api');
 const NRAgent = API.getNRAgent();
 const HC = require('./health-check');
@@ -83,6 +83,7 @@ function generateSecEvent(securityMetadata) {
         }
 
         let apiId = shaUtil.getSHA256ForData(traceObject.stacktrace.join('|') + uri);
+        apiId = securityMetadata.eventType + HYPHEN + apiId;
         const agentModule = Agent.getAgent();
         const metaData = {};
         if (traceObject.sourceDetails && traceObject.sourceDetails.evalObj) {

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

@@ -23,10 +23,11 @@ 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` +
-    `SEC_HOME: ${njsAgentConstants.CSEC_HOME}\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` +
@@ -35,10 +36,10 @@ const statusTemplate = 'Snapshot timestamp: : %s\n' +
     `Current working directory: ${process.cwd()}\n` +
     `Agent mode: ${commonUtils.getCSECmode()}\n` +
     'Application server: %s\n' +
-    'Application Framework: %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' +
+    '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' +
@@ -83,7 +84,7 @@ function getFormattedData() {
     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, njsAgentConstants.FRAMEWORK, commonUtils.getWSHealthStatus(), appInfo.policyVersion, getKeyValPairs(lastHC.stats), getKeyValPairs(lastHC.serviceStatus), JSON.stringify(getBufferedErrors()), JSON.stringify(getBufferedHC()));
+    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;
 }
 

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@newrelic/security-agent",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "New Relic Security Agent for Node.js",
   "main": "index.js",
-  "jsonVersion": "1.1.1",
+  "jsonVersion": "1.2.0",
   "contributors": [
     {
       "name": "Sumit Suthar",
@@ -58,8 +58,6 @@
     "ws": "^8.14.2"
   },
   "devDependencies": {
-    "@grpc/grpc-js": "^1.9.5",
-    "@grpc/proto-loader": "^0.7.10",
     "@hapi/hapi": "^21.3.0",
     "@koa/router": "^12.0.0",
     "@newrelic/newrelic-oss-cli": "^0.1.2",

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

@@ -1,53 +0,0 @@
-/*
- * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
- */
-
-
-const grpcServiceMap = new Map();
-const grpcMethodMap = new Map();
-/**
- * Utility to set service based on key value pair
- * @param {*} key 
- * @param {*} value 
- */
-function setService(key, value){
-    grpcServiceMap.set(key,value);
-}
-
-/**
- * Utility to get service corresponding to key
- * @param {*} key 
- * @returns 
- */
-function getService(key){
-    return grpcServiceMap.get(key);
-}
-
-/**
- * Utility to set method object
- * @param {*} key 
- * @param {*} value 
- */
-function setMethod(key, value){
-    grpcMethodMap.set(key,value);
-}
-
-/**
- * Utility to get method object
- * @param {*} key 
- * @returns 
- */
-function getMethod(key){
-    return grpcMethodMap.get(key);
-}
-
-module.exports={
-    setService,
-    getService,
-    grpcServiceMap,
-    setMethod,
-    getMethod,
-    grpcMethodMap
-
-}