@newrelic/security-agent 1.1.1 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+### v1.3.0 (2024-05-31)
+#### Features
+* Added route field in security event for API endpoint mapping
+#### Bug fixes
+* Fix for control commands acknowledgement in security agent 
+* Added assert for typeof response data in Reflected XSS validation 
+* Updated @grpc/grpc-js instrumentation to instrument submodules 
+* Handling to convert header values into string
+#### Miscellaneous chores
+* Updated log level for critical messages 
+* Readme update
+* (deps-dev): bump axios from 0.21.4 to 1.7.2
+
+### v1.2.0 (2024-04-12)
+#### Features
+* Added instrumentation for express framework's res.download() and res.sendFile()
+#### Bug fixes
+* Handling to decrypt fuzz header data for IAST scanning 
+* Logging and snapshot file fixes
+#### Miscellaneous chores
+* Prepend vulnerability case type with apiId
+* Updated jsonVersion to v1.2.0
+* Bumped undici from 5.28.3 to 5.28.4
+
 ### v1.1.1 (2024-03-21)
 #### Bug fixes
 * Reverted IAST support for gRPC.

package/README.md

@@ -99,7 +99,7 @@ New Relic hosts and moderates an online forum where you can interact with New Re
 
 ## Contribute
 
-Any feedback provided to New Relic about the New Relic security agent, including feedback provided as source code, comments, or other copyrightable or patentable material, is provided to New Relic under the terms of the Apache Software License, version 2. If you do not provide attribution information or a copy of the license with your feedback, you waive the performance of those requirements of the Apache License with respect to New Relic. The license grant regarding any feedback is irrevocable and persists past the termination of the preview license.
+Any feedback provided to New Relic about the New Relic security agent, including feedback provided as source code, comments, or other copyrightable or patentable material, is provided to New Relic under the terms of the New Relic Software License v1.0. If you do not provide attribution information or a copy of the license with your feedback, you waive the performance of those requirements of the New Relic Software License v1.0 with respect to New Relic. The license grant regarding any feedback is irrevocable.
 Keep in mind that when you submit a pull request or other feedback, you’ll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
 If you have any questions drop us an email at opensource@newrelic.com.
 

package/THIRD_PARTY_NOTICES.md

@@ -38,6 +38,7 @@ code, the source code can be found at [https://github.com/newrelic/csec-node-age
 
 **[devDependencies](#devDependencies)**
 
+* [@grpc/proto-loader](#grpcproto-loader)
 * [@hapi/hapi](#hapihapi)
 * [@koa/router](#koarouter)
 * [@newrelic/newrelic-oss-cli](#newrelicnewrelic-oss-cli)
@@ -616,6 +617,215 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ## devDependencies
 
+### @grpc/proto-loader
+
+This product includes source derived from [@grpc/proto-loader](https://github.com/grpc/grpc-node) ([v0.7.7](https://github.com/grpc/grpc-node/tree/v0.7.7)), distributed under the [Apache-2.0 License](https://github.com/grpc/grpc-node/blob/v0.7.7/LICENSE):
+
+```
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+```
+
 ### @hapi/hapi
 
 This product includes source derived from [@hapi/hapi](https://github.com/hapijs/hapi) ([v21.3.2](https://github.com/hapijs/hapi/tree/v21.3.2)), distributed under the [BSD-3-Clause License](https://github.com/hapijs/hapi/blob/v21.3.2/LICENSE.md):
@@ -2631,7 +2841,7 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ### undici
 
-This product includes source derived from [undici](https://github.com/nodejs/undici) ([v5.28.3](https://github.com/nodejs/undici/tree/v5.28.3)), distributed under the [MIT License](https://github.com/nodejs/undici/blob/v5.28.3/LICENSE):
+This product includes source derived from [undici](https://github.com/nodejs/undici) ([v5.28.4](https://github.com/nodejs/undici/tree/v5.28.4)), distributed under the [MIT License](https://github.com/nodejs/undici/blob/v5.28.4/LICENSE):
 
 ```
 MIT License

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

@@ -54,6 +54,7 @@ module.exports = {
     DOUBLE_DOLLAR: '$$',
     LOADING_MODULE: 'Loading module ',
     EMPTY_STRING: '',
+    COMMA: ',',
     QUESTION_MARK: '?',
     DOUBLE_PIPE: '||',
     DOTDOTSLASH: '../',

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

@@ -0,0 +1,53 @@
+/*
+ * 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
+
+}

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

@@ -9,10 +9,11 @@ const secTrace = require('./sec-trace');
 const requestManager = require('./request-manager');
 const routeManager = require('./route-manager');
 const async_hooks = require('async_hooks');
+const crypto = require('crypto');
 
-let  AGENT_DIR = path.join(__dirname, '../../');
+let AGENT_DIR = path.join(__dirname, '../../');
 
-if(process.platform == 'win32'){
+if (process.platform == 'win32') {
     AGENT_DIR = path.join(__dirname, "..\\..\\");
 }
 const NR_LIB = '/newrelic/lib';
@@ -36,10 +37,11 @@ const API = require("../../nr-security-api");
 const logger = API.getLogger();
 
 createSkipList();
-const fs =  require('fs');
+const fs = require('fs');
 const cp = require('child_process');
 const requestIp = require('request-ip');
-const URL = require('url')
+const URL = require('url');
+const { EMPTY_STR } = require('./constants');
 
 /**
  * Creates a list of loaded internal modules,
@@ -47,7 +49,7 @@ const URL = require('url')
  *
  * @returns {Array} loadList
  */
- function createSkipList () {
+function createSkipList() {
     let loadList = [];
     process.moduleLoadList.forEach(function (loadString) {
         loadList.push(loadString.split(SPACE_CHARACTER).pop());
@@ -63,7 +65,7 @@ const URL = require('url')
 }
 
 
-function getTraceObject (shim) {
+function getTraceObject(shim) {
     const trace = stackTraceModule.get();
     const traceLength = 10;
     const stkTrace = [];
@@ -81,18 +83,18 @@ function getTraceObject (shim) {
     const request = requestManager.getRequest(shim);
     const key = request.method + ATTHERATE + request.uri;
     const routeFile = routeManager.getRoute(key);
-    if(routeFile){
+    if (routeFile) {
         stkTrace.push(routeFile);
     }
-    const sourceDetails = secTrace.getSourceDetailsFromTrace(trace,__filename, stkTrace);
+    const sourceDetails = secTrace.getSourceDetailsFromTrace(trace, __filename, stkTrace);
     const traceObject = {
-        sourceDetails:sourceDetails,
+        sourceDetails: sourceDetails,
         stacktrace: stkTrace
     }
     return traceObject;
 }
 
-function getTraceObjectFallback (request) {
+function getTraceObjectFallback(request) {
     const trace = stackTraceModule.get();
     const traceLength = 10;
     const stkTrace = [];
@@ -109,19 +111,19 @@ function getTraceObjectFallback (request) {
     }
     const key = request.method + ATTHERATE + request.uri;
     const routeFile = routeManager.getRoute(key);
-    if(routeFile){
+    if (routeFile) {
         stkTrace.push(routeFile);
     }
-    const sourceDetails = secTrace.getSourceDetailsFromTrace(trace,__filename, stkTrace);
+    const sourceDetails = secTrace.getSourceDetailsFromTrace(trace, __filename, stkTrace);
     const traceObject = {
-        sourceDetails:sourceDetails,
+        sourceDetails: sourceDetails,
         stacktrace: stkTrace
     }
     return traceObject;
 }
 
 
-function traceElementForRoute () {
+function traceElementForRoute() {
     const stkTrace = [];
     const trace = stackTraceModule.get();
     let methodName = null;
@@ -130,7 +132,7 @@ function traceElementForRoute () {
         const funcName = trace[i].getFunctionName();
         const fileName = trace[i].getFileName();
         const lineNumber = trace[i].getLineNumber();
-        if(i>0){
+        if (i > 0) {
             methodName = trace[i - 1].getMethodName();
         }
 
@@ -143,11 +145,11 @@ function traceElementForRoute () {
     return stkTrace;
 }
 
-function getExecutionId(){
+function getExecutionId() {
     return async_hooks.executionAsyncId();
 }
 
-function createPathIfNotExist (dir) {
+function createPathIfNotExist(dir) {
     try {
         if (!fs.existsSync(dir)) {
             fs.mkdirSync(dir, 770, { recursive: true });
@@ -169,49 +171,87 @@ function createPathIfNotExist (dir) {
  */
 function addRequestData(shim, request) {
     try {
-      const data = Object.assign({});
-      const segment = shim.getActiveSegment();
-      if (segment && segment.transaction) {
-        data.protocol = (request.connection && request.connection.encrypted) ? 'https' : 'http';
-        data.body = null;
-        data.headers = request.headers;
-        data.url = request.url;
-        data.method = request.method;
-        data.httpVersion = request.httpVersion;
-        data.serverPort = segment.transaction.port;
-        data.contextPath = '/';
-        const queryObject = URL.parse(request.url, true).query;
-        data.parameterMap = {};
-        if (queryObject) {
-          Object.keys(queryObject).forEach(function (key) {
-            if (queryObject[key]) {
-              if (!data.parameterMap[key]) {
-                data.parameterMap[key] = new Array(queryObject[key].toString());
-              }
+        const data = Object.assign({});
+        const segment = shim.getActiveSegment();
+        if (segment && segment.transaction) {
+            data.protocol = (request.connection && request.connection.encrypted) ? 'https' : 'http';
+            data.body = null;
+            data.headers = request.headers;
+            data.url = request.url;
+            data.method = request.method;
+            data.httpVersion = request.httpVersion;
+            data.serverPort = segment.transaction.port;
+            data.contextPath = '/';
+            const queryObject = URL.parse(request.url, true).query;
+            data.parameterMap = {};
+            if (queryObject) {
+                Object.keys(queryObject).forEach(function (key) {
+                    if (queryObject[key]) {
+                        if (!data.parameterMap[key]) {
+                            data.parameterMap[key] = new Array(queryObject[key].toString());
+                        }
+                    }
+                });
+            }
+            data.clientIP = requestIp.getClientIp(request);
+            const transactionId = segment.transaction.id;
+            const storedRequest = requestManager.getRequestFromId(transactionId);
+            if (storedRequest && storedRequest.uri) {
+                data.uri = storedRequest.uri;
+                data.parameterMap = storedRequest.parameterMap;
+            }
+            requestManager.setRequest(transactionId, data);
+            if (shim.agent.getLinkingMetadata()) {
+                let linkingMetadata = shim.agent.getLinkingMetadata();
+                if (linkingMetadata['trace.id']) {
+                    let traceId = linkingMetadata['trace.id'];
+                    requestManager.setRequest(traceId, data)
+                }
             }
-          });
         }
-        data.clientIP = requestIp.getClientIp(request);
-        const transactionId = segment.transaction.id;
-        const storedRequest = requestManager.getRequestFromId(transactionId);
-        if (storedRequest && storedRequest.uri) {
-          data.uri = storedRequest.uri;
-          data.parameterMap = storedRequest.parameterMap;
+    } catch (error) {
+        logger.debug("Error while preparing incoming request:", error);
+    }
+}
+
+function decryptData(encryptedData) {
+    let decryptedData = EMPTY_STR;
+    try {
+
+        const linkingMetadata = API.newrelic.getLinkingMetadata();
+        let entityGuid = linkingMetadata['entity.guid'];
+        let password = entityGuid;
+        let salt = password.slice(0, 16);
+        //derive key
+        const key = crypto.pbkdf2Sync(password, salt, 1024, 32, 'sha1');
+        const decipher = crypto.createDecipheriv('aes-256-cbc', key, Buffer.alloc(16));
+        let decrypted = decipher.update(encryptedData, 'hex');
+        decrypted += decipher.final();
+        decryptedData = decrypted.slice(16, decrypted.length);
+    } catch (error) {
+        logger.debug("Error while decrypting the data:", error);
+    }
+    return decryptedData;
+
+}
+
+function hashVerifier(decryptedData, hashFromSE) {
+    let flag = false;
+    try {
+        const hash = crypto.createHash('sha256'); // Create a new hash object
+        hash.update(decryptedData); // Write data to the hash object
+        let calculatedSHA256Hash = hash.digest('hex');
+        if (calculatedSHA256Hash === hashFromSE) {
+            flag = true;
         }
-        requestManager.setRequest(transactionId, data);
-        if(shim.agent.getLinkingMetadata()){
-            let linkingMetadata = shim.agent.getLinkingMetadata();
-            if(linkingMetadata['trace.id']){
-              let traceId = linkingMetadata['trace.id'];
-              requestManager.setRequest(traceId, data)
-            }
-          }
-      }
     } catch (error) {
-      logger.debug("Error while preparing incoming request:", error);
-    }  
-  }
-  
+        logger.debug("Error while calculating SHA256 of decrypted data:", error);
+    }
+
+    return flag;
+
+}
+
 
 module.exports = {
     getTraceObject,
@@ -219,5 +259,7 @@ module.exports = {
     getExecutionId,
     createPathIfNotExist,
     getTraceObjectFallback,
-    addRequestData
+    addRequestData,
+    decryptData,
+    hashVerifier
 }

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

@@ -15,8 +15,18 @@
  */
 function getSecurityMetaData(request, interceptedArgs, traceObject, executionId, eventType, eventCategory) {
     const securityMetadata = {};
-    const httpRequest = Object.assign({},request);
-    if(httpRequest.tempFiles){
+    const rHeaders = request.headers;
+    try {
+        Object.keys(rHeaders).forEach(key => {
+            if (rHeaders[key]) {
+                rHeaders[key] = String(rHeaders[key]);
+            }
+        });
+    } catch (error) {
+    }
+    request.headers = rHeaders;
+    const httpRequest = Object.assign({}, request);
+    if (httpRequest.tempFiles) {
         delete httpRequest.tempFiles;
     }
     securityMetadata.request = httpRequest

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

@@ -18,8 +18,11 @@ const lodash = require('lodash');
 const routeManager = require('../../core/route-manager');
 const API = require("../../../nr-security-api");
 const logger = API.getLogger();
+const { EVENT_TYPE, EVENT_CATEGORY } = require('../../core/event-constants');
+const { STRING } = require('../../core/constants');
+const securityMetaData = require('../../core/security-metadata');
 
-module.exports = function initialize(shim, express, moduleName) {
+module.exports = function initialize(shim, express) {
   logger.info("Instrumenting express")
   if (!express || !express.Router) {
     return false
@@ -28,7 +31,8 @@ module.exports = function initialize(shim, express, moduleName) {
   if (express.Router.use) {
     wrapExpress4(shim, express)
   } 
- 
+  expressFileHook(shim, express && express.response, 'download')
+  expressFileHook(shim, express && express.response, 'sendFile')
 }
 
 /**
@@ -106,4 +110,40 @@ function extractParams(shim, req) {
       requestManager.setRequest(segment.transaction.id, request);
     }
   }
-}
+}
+
+/**
+ * Wrapper for resp.download()
+ * @param {*} shim 
+ * @param {*} mod 
+ * @param {*} fun 
+ */
+function expressFileHook(shim, mod, fun){
+  shim.wrap(mod, fun, function makeFAWrapper(shim, fn) {
+    if (!shim.isFunction(fn)) {
+      return fn
+    }
+    logger.debug(`Instrumenting express.response.${fun}`)
+    return function FAWrapper() {
+      let parameters = Array.prototype.slice.apply(arguments);
+      const interceptedArgs = [arguments[0]];
+      shim.interceptedArgs = interceptedArgs;
+      const request = requestManager.getRequest(shim);
+      if (request && typeof arguments[0] === STRING && !lodash.isEmpty(arguments[0])) {
+        const traceObject = secUtils.getTraceObject(shim);
+        try {
+          parameters[0] = path.resolve(parameters[0]);
+        } catch (error) {
+
+        }
+        let absoluteParameters = [parameters[0]];
+        const secMetadata = securityMetaData.getSecurityMetaData(request, absoluteParameters, traceObject, secUtils.getExecutionId(), EVENT_TYPE.FILE_OPERATION, EVENT_CATEGORY.FILE)
+        this.secEvent = API.generateSecEvent(secMetadata);
+        API.sendEvent(this.secEvent);
+      }
+      return fn.apply(this, arguments);
+    };
+  });
+}
+
+