@newrelic/security-agent
Advanced tools
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.
Typically, most users use the version auto-installed by the New Relic Node.js agent. You can see agent install instructions here.
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.
npm install @newrelic/security-agent@latest
For more information, please see New Relic Node.js agent installation guide
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
/**
* 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
}
}
The Developer docs for writing instrumentation will be of help. We particularly recommend the tutorials and the shim API documentation.
httphttpsfschild_processFor more information, please see New Relic Node.js agent compatibility and requirements.
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 with the extension .tap.js.
To run the full suite, run: npm test.
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/
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, 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.
If you would like to contribute to this project, review these guidelines.
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.
v0.5.0 (2023-11-17)
FAQs
New Relic Security Agent for Node.js
The npm package @newrelic/security-agent receives a total of 567,776 weekly downloads. As such, @newrelic/security-agent popularity was classified as popular.
We found that @newrelic/security-agent demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."