@newrelic/security-agent 0.0.1

package/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# New Relic CSEC Agent Contributor License Agreement
+
+The New Relic CSEC Agent is in preview.  Any feedback provided to New Relic about the New Relic CSEC 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 this license.
+
+Keep in mind that you will need to sign the CSEC Agent CLA via the click-through using CLA-Assistant. If you have any questions, please drop our New Relic GitHub team an email at opensource@newrelic.com.
+
+For more information about CLAs, please check out Alex Russell’s excellent post,
+[“Why Do I Need to Sign This?”](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
+
+## Contributing Feedback
+
+Before contributing please read the
+[code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) and [search the issue tracker](issues); your issue may have already been discussed or fixed in `main`. To contribute,
+[fork](https://help.github.com/articles/fork-a-repo/) this repository, commit your changes, and [send a Pull Request](https://help.github.com/articles/using-pull-requests/).
+
+Note that our [code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants.
+
+## Feedback for Feature Requests
+
+Feature requests should be submitted in the [Issue tracker](../../issues), with a description of the expected behavior & use case, where they’ll remain closed until sufficient interest, [e.g. :+1: reactions](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/), has been [shown by the community](../../issues?q=label%3A%22votes+needed%22+sort%3Areactions-%2B1-desc).
+Before submitting an Issue, please search for similar ones in the
+[closed issues](../../issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement).
+

package/LICENSE

@@ -0,0 +1,43 @@
+## New Relic Pre-Release Software Notice
+
+### 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
+
+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.
+
+### 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/.
+
+### Confidentiality
+
+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.
+
+### 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.
+
+### 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.
+
+### 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.
+
+### 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. 

package/README.md

@@ -0,0 +1,98 @@
+# New Relic Node.js security agent
+
+**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. 
+
+## Installation
+
+Typically, most users use the version auto-installed by the [New Relic Node.js agent](https://github.com/newrelic/node-newrelic). You can see agent install instructions [here](https://github.com/newrelic/node-newrelic#installation-and-getting-started).
+
+In some cases, installing a specific version is ideal. For example, new features or major changes might be released via a major version update to this module, prior to inclusion in the main New Relic Node.js Agent.
+
+```sh
+npm install @newrelic/security-agent@latest
+```
+
+For more information, please see New Relic Node.js agent [installation guide](https://docs.newrelic.com/docs/apm/agents/nodejs-agent/installation-configuration/install-nodejs-agent/)
+
+The `@newrelic/security-agent` must be explicitly enabled in order to perform IAST analysis of the application. In the newrelic.js, set the following parameters
+
+```js
+ /**
+  * Security Configurations
+  */
+   security: {
+    /**
+     * enables/disables security agent functions and generation of events.
+     */
+    enabled: true,
+    /**
+      * To completely disable security, set agent.enabled flag to false. If the flag is set to false, the security module is not loaded. This property is read only once at application start.
+      */
+    agent: {
+      enabled: true
+    }
+  }
+```
+
+## Getting Started
+
+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  Modules
+
+- Node.js core modules
+    - `http` 
+    - `https`
+    - `fs`
+    - `child_process`
+- [mysql](https://www.npmjs.com/package/mysql)(2.16.x and above)
+- [mysql2](https://www.npmjs.com/package/mysql2) (2.x and above)
+- [pg](https://www.npmjs.com/package/pg)(7.x and above)
+- [mongodb](https://www.npmjs.com/package/mongodb)(2.x, 3.x and 4.x)
+- [express](https://www.npmjs.com/package/express)(4.x and above)
+- [@koa/router](https://www.npmjs.com/package/@koa/router) ((9.x and above)
+- [koa-router](https://www.npmjs.com/package/koa-router)(9.x and above)
+- [@hapi/hapi](https://www.npmjs.com/package/@hapi/hapi)(19.x and above)
+- [fastify](https://www.npmjs.com/package/fastify)(2.x, 3.x and 4.x)
+- [restify](https://www.npmjs.com/package/restify)(8.x, 9.x, 10.x and 11.x)
+- [director](https://www.npmjs.com/package/director)(1.2.x)
+- [ldapjs](https://www.npmjs.com/package/ldapjs)(2.x and above)
+- [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) 
+
+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/).
+
+## Testing
+
+The module includes a suite of unit and functional tests which should be used to
+verify that your changes don't break existing functionality.
+
+All tests are stored in `tests/` and are written using
+[Tap](https://www.npmjs.com/package/tap) with the extension `.tap.js`.
+
+To run the full suite, run: `npm test`.
+
+## Support
+
+New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices.  You can find this project's topic/threads here:  Add the url for the support thread here: https://forum.newrelic.com/s/
+
+## 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.
+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.
+
+**A note about vulnerabilities**
+
+As noted in our [security policy](https://github.com/newrelic/csec-node-agent/security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
+
+If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [HackerOne](https://hackerone.com/newrelic).
+
+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 `@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.