@newrelic/security-agent 0.7.0 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+### v1.1.0 (2024-03-19)
+#### Features
+* IAST support for grpc 
+* Functionality to report API endpoints of the application
+* IAST support for undici
+#### Bug fixes
+* Updated permissions for file/directory created by security agent
+#### Miscellaneous chores
+* Bumped follow-redirects from v1.15.2 to v1.15.4  
+* Updated axios to v1.6.8
+* Bumped ip from v2.0.0 to v2.0.1
+* Bumped undici from 5.28.2 to v5.28.3
+* Readme update
+
+### v1.0.1 (2024-02-07)
+#### Bug fixes
+* Reporting of framework in security event json 
+#### Miscellaneous chores
+* Updated software license to New Relic Software License Version 1.0
+* Ability to send critical messages on successful startup of agent
+* Updated Copyright headers
+* Updated license in readme
+
 ### v0.7.0 (2024-01-18)
 #### Features
 * Handling to exclude unsupported content types from rxss processing

package/LICENSE

@@ -1,43 +1,38 @@
-## New Relic Pre-Release Software Notice
+## New Relic Software License v1.0
 
 ### Acceptance
 
-This software license applies to the repositories, directories, or files that it has been associated with (referred to here as the “Pre-Release Software”). In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
-License
+This software license applies to the repositories, directories, or files that it has been associated with (referred to here as “the Software”). In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
 
-New Relic, Inc. (“New Relic”) grants you a license under its copyrights and patents to do everything necessary for you to use the Pre-Release Software for the Permitted Purposes and subject to your compliance with the Confidentiality terms and all other Restrictions on Use.  All other uses are prohibited.
+### License
 
-### Permitted Purposes
-
-The Pre-Release Software is solely for use with New Relic’s proprietary SaaS service (“New Relic Service”).   To use the Pre-Release Software you must have a valid and active  subscription agreement to the New Relic Service. You may not use the Pre-Release Software in conjunction with any other similar service. 
-
-Use of the Pre-Release Software is limited to evaluation and feedback, including pull requests, of the pre-release features and capabilities. The use of the Pre-Release Software requires a signed New Relic Pre-Release Agreement.  The New Relic Pre-Release Agreement will control in event of a conflict with this license.  The Pre-Release Software is also subject to the New Relic pre-release policy.  A copy of the New Relic Pre-release policy available at https://docs.newrelic.com/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy/.
+New Relic grants you a license for the Software to do everything you might do with the Software that would otherwise infringe the New Relic’s copyrights or patent rights, conditional on only using the Software for Permitted Purposes and compliance with all other Restrictions on Use. All other uses are prohibited. 
 
-### Confidentiality
+### Permitted Purposes
 
-Any Pre-Release Software not posted publicly contains New Relic Trade Secrets. You may not disclose the features and capabilities of the Pre-Release Software to any third party by any means. You will use commercially reasonable measures to maintain the secrecy of the features and capabilities of the Pre-Release Software. Without limiting the permissions you receive under any open source software (“OSS”) license, you may not disclose the source code of any OSS included as part of the Pre-Release Software in a way that discloses the New Relic Trade Secrets.
+The Software is solely for use with New Relic’s proprietary SaaS service (“New Relic Service”). To use the Software you must have a valid and active subscription agreement to the New Relic Service. You may not use the Software in conjunction with any other similar service.
 
-### Restrictions on Use 
+### Restrictions on Use
 
-1. The use of the Pre-Release Software is limited to you and your organization. You cannot expose the Pre-Release Software to third parties via the network or use the Pre-Release Software on behalf of anyone else.
-2. You cannot modify the Pre-Release Software. You can compile or link the Pre-Release Software into your programs as described in the New Relic Documentation, but you cannot otherwise make any derivative works of the Pre-Release Software.
-3. You cannot reverse engineer or decompile the Pre-Release Software. 
-4. You cannot use the Pre-Release Software for competitive analysis, benchmarking, or any purposes that compete with or are intended to compete with New Relic.
-5. You cannot remove or obscure any proprietary notices in the Pre-Release Software.
-6. You can only copy the Software to the extent needed to use the Pre-Release Software within your organization. You cannot distribute the Software to any third parties.
-7. You can only use the New Relic Services and the Pre-Release Software consistent with New Relic’s product Documentation and Acceptable Use Policy.
+1. The use of the Software is limited to you and your organization. You cannot expose the Software to third parties via the network or use the Software on behalf of anyone else.
+2. You cannot modify the Software. You can compile or link the Software into your programs as described in the New Relic Documentation, but you cannot otherwise make any derivative works of the Software.
+3. You cannot reverse engineer or decompile the Software. 
+4. You cannot use the Software for competitive analysis, benchmarking, or any purposes that compete with or are intended to compete with New Relic.
+5. You cannot remove or obscure any proprietary notices in the Software.
+6. You can only copy the Software to the extent needed to use the Software within your organization. You cannot distribute the Software to any third parties.
+7. You can only use the New Relic Services and the Software consistent with your subscription agreement with New Relic, New Relic’s product Documentation and Acceptable Use Policy.
 
 ### Intellectual Property
 
-Any feedback provided to New Relic about the Pre-Release Software, 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 this license.
+Any feedback provided to New Relic about the Software, 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 this license.
 
 ### Termination
 
-This license terminates when the Pre-Release Software stops being provided by New Relic or when described by the New Relic Pre-Release Agreement, whichever comes first. When this license terminates, you have a commercially reasonable time to either remove the Pre-Release Software from your systems or to upgrade to a publicly released version of the Software.
+This license terminates when the Software stops being provided by New Relic or when described by the New Relic subscription agreement, whichever comes first. When this license terminates, you have a commercially reasonable time to either remove the Software from your systems.
 
 ### Other Terms
 
-1. The Pre-Release Software is provided “AS IS.” New Relic disclaims all warranties, whether express, implied, statutory or otherwise, including warranties of merchantability, fitness for a particular purpose, title and noninfringement.
-2. The Pre-Release Software has known flaws.  You use the Pre-Release Software at your own risk.
-3. To the full extent permitted by law, New Relic will have no liability arising from or related to the Pre-Release Software or from this license for any direct, indirect, special, incidental, or consequential damages of any kind, even if advised of their possibility in advance, and regardless of legal theory (whether contract, tort, negligence, strict liability or otherwise).
-4. The Pre-Release Software may contain third-party software, including open source software. The third party software is governed by its own license and subject to its own terms, disclosed in the provided licensing information associated with the third party components.   If a source code disclosure is required under the terms of the license covering any OSS component, the source code can be requested of New Relic by emailing opensource@newrelic.com. 
+1. The Software is provided “AS IS.”  New Relic disclaims all warranties, whether express, implied, statutory or otherwise, including warranties of merchantability, fitness for a particular purpose, title, and noninfringement.
+2. To the full extent permitted by law, New Relic will have no liability arising from or related to the Software or from this license for any direct, indirect, special, incidental, or consequential damages of any kind, even if advised of their possibility in advance, and regardless of legal theory (whether contract, tort, negligence, strict liability or otherwise).
+3. The Software may contain third-party software, including open source software (“OSS”). The third party software is governed by its own license and subject to its own terms, disclosed in the provided licensing information associated with the third party components. If a source code disclosure is required under the terms of the license covering any OSS component, the source code can be requested of New Relic by emailing opensource@newrelic.com.   
+

package/README.md

@@ -3,7 +3,7 @@
 
 **Note**: The IAST capability should only be used in pre-production environments as the application is tested for real exploitable vulnerabilities.
 
-The New Relic security agent is in preview and is not generally available. This module enables instrumentation of a Node.js application for interactive application security testing(IAST) and exposes exploitable vulnerabilities. 
+The New Relic security agent enables instrumentation of a Node.js application for Interactive Application Security Testing(IAST) and exposes exploitable vulnerabilities. 
 
 ## Installation
 
@@ -67,9 +67,23 @@ The [Developer docs](http://newrelic.github.io/node-newrelic/) for writing instr
 - [ldapts](https://www.npmjs.com/package/ldapts)(2.x and above)
 - [xpath](https://www.npmjs.com/package/xpath)(0.0.20 and above)
 - [xpath.js](https://www.npmjs.com/package/xpath.js)(0.0.1 and above) 
+- [undici](https://www.npmjs.com/package/undici)(4.7.0 and above) 
+- [@grpc/grpc-js](https://www.npmjs.com/package/@grpc/grpc-js)(1.4.x and above)
 
 For more information, please see New Relic Node.js agent [compatibility and requirements](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent/).
 
+### Supported Vulnerabilities
+- Remote Code Execution
+- SQL Injection
+- NoSQL Injection
+- Stored XSS
+- Reflected XSS
+- Reverse Shell attack
+- File Access
+- SSRF
+- Application Integrity Violation
+- LDAP Injection
+- XPath Injection
 ## Testing
 
 The module includes a suite of unit and functional tests which should be used to
@@ -99,7 +113,7 @@ If you believe you have found a security vulnerability in this project or any of
 If you would like to contribute to this project, review [these guidelines](https://github.com/newrelic/csec-node-agent/blob/main/CONTRIBUTING.md).
 
 ## License
-The New Relic security agent is licensed under the New Relic Pre-Release Software Notice.
+The New Relic security agent is licensed under the New Relic Software License v1.0.
 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 

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

@@ -1,7 +1,7 @@
 
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 'use strict';

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

@@ -1,7 +1,7 @@
 
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 const EVENT_TYPE = {

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/request-manager.js

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 const requestMap = new Map();

package/lib/instrumentation-security/core/route-manager.js

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 
@@ -10,8 +10,8 @@ const routeMap = new Map();
  * @param {*} key 
  * @param {*} value 
  */
-function setRoute(key, value){
-    routeMap.set(key,value);
+function setRoute(key, value) {
+    routeMap.set(key, value);
 }
 
 /**
@@ -19,12 +19,35 @@ function setRoute(key, value){
  * @param {*} key 
  * @returns 
  */
-function getRoute(key){
+function getRoute(key) {
     return routeMap.get(key);
 }
 
-module.exports={
+/**
+ * Utility to get all api end points
+ * @returns all keys from routeMap
+ */
+function getAllAPIEndPoints() {
+    let apiEndpoints = [];
+    try {
+        routeMap.forEach((value, key) => {
+            let obj = {};
+            let splitted = key.split('@');
+            obj.method = splitted[0];
+            obj.path = splitted[1];
+            obj.handler = routeMap.get(key);
+            apiEndpoints.push(obj);
+        })
+    } catch (error) {
+
+    }
+
+    return apiEndpoints;
+}
+
+module.exports = {
     getRoute,
     setRoute,
-    routeMap
+    routeMap,
+    getAllAPIEndPoints
 }

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

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 const path = require('path');

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

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 const stackTraceModule = require('./stack-trace');
@@ -150,11 +150,11 @@ function getExecutionId(){
 function createPathIfNotExist (dir) {
     try {
         if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir, 777, { recursive: true });
+            fs.mkdirSync(dir, 770, { recursive: true });
             logger.info(dir + ' Created');
-            fs.chmodSync(dir, 0o777);
+            fs.chmodSync(dir, 0o770);
         } else {
-            fs.chmodSync(dir, 0o777);
+            fs.chmodSync(dir, 0o770);
             logger.debug(dir + ' Already Exists');
         }
     } catch (error) {

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

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 /**

package/lib/instrumentation-security/core/stack-trace.js

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
  'use strict';

package/lib/instrumentation-security/hooks/@nestjs/nr-nestjs-core.js

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 'use strict'

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

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 

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

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 'use strict'
@@ -27,9 +27,8 @@ module.exports = function initialize(shim, express, moduleName) {
 
   if (express.Router.use) {
     wrapExpress4(shim, express)
-  } else {
-    // wrapExpress3(shim, express)
-  }
+  } 
+ 
 }
 
 /**
@@ -57,7 +56,6 @@ function wrapExpress4(shim, express) {
     }
   })
 
-
   //Wrapper to hook process_params method to extract out path param and query params.
   shim.wrap(express.Router, 'process_params', function wrapParam(shim, fn) {
     if (!shim.isFunction(fn)) {

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

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 'use strict'

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

@@ -1,6 +1,6 @@
 /*
  * Copyright 2023 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: New Relic Pre-Release
+ * SPDX-License-Identifier: New Relic Software License v1.0
  */
 
 module.exports = initialize;