Skip to content

Zen protects your Node app against attacks with one line of code. Get peace of mind— at runtime.

License

Notifications You must be signed in to change notification settings

AikidoSec/firewall-node

Repository files navigation

Zen by Aikido for Node.js

Zen, in-app firewall for Node.js | by Aikido

NPM Version Codecov NPM License PRs Welcome Unit tests End to end tests

Zen, your in-app firewall for peace of mind– at runtime.

Zen by Aikido is an embedded Web Application Firewall that autonomously protects Node.js apps against common and critical attacks.

It protects your Node.js apps by preventing user input containing dangerous strings, which allow injection, pollution, and path traversal attacks. It runs on the same server as your Node.js app for simple installation and zero maintenance.

Features

Zen will autonomously protect your Node.js applications against:

Zen operates autonomously on the same server as your Node.js app to:

  • ✅ Secure your app like a classic web application firewall (WAF), but with none of the infrastructure or cost.
  • ✅ Rate limit specific API endpoints by IP or by user
  • ✅ Allow you to block specific users manually

Supported libraries and frameworks

Zen for Node.js 16+ is compatible with:

Web frameworks

Database drivers

Cloud providers

ORMs and query builders

See list above for supported database drivers.

API tools

Data serialization tools

Shell tools

Routers

Installation

We recommend testing Zen locally or on staging before deploying to production.

# The --save-exact makes sure that you don't automatically install a newer version
$ npm install --save-exact @aikidosec/firewall

# The --exact makes sure that you don't automatically install a newer version
$ yarn add --exact @aikidosec/firewall

For framework- and provider- specific instructions, check out our docs:

Reporting to your Aikido Security dashboard

Aikido is your no nonsense application security platform. One central system that scans your source code & cloud, shows you what vulnerabilities matter, and how to fix them - fast. So you can get back to building.

Zen is a new product by Aikido. Built for developers to level up their security. While Aikido scans, get Zen for always-on protection.

You can use some of Zen’s features without Aikido, of course. Peace of mind is just a few lines of code away.

But you will get the most value by reporting your data to Aikido.

You will need an Aikido account and a token to report events to Aikido. If you don't have an account, you can sign up for free.

Here's how:

  • Log in to your Aikido account.
  • Go to Zen.
  • Go to apps.
  • Click on Add app.
  • Choose a name for your app.
  • Click Generate token.
  • Copy the token.
  • Set the token as an environment variable, AIKIDO_TOKEN, using dotenv or another method of your choosing.

Running in production (blocking) mode

By default, Zen will only detect and report attacks to Aikido.

To block requests, set the AIKIDO_BLOCK environment variable to true.

See Reporting to Aikido to learn how to send events to Aikido.

License

This program is offered under a commercial and under the AGPL license. You can be released from the requirements of the AGPL license by purchasing a commercial license. Buying such a license is mandatory as soon as you develop commercial activities involving the Zen software without disclosing the source code of your own applications.

For more information, please contact Aikido Security at this address: [email protected] or create an account at https://app.aikido.dev.

Performance

We run a benchmark on every commit to ensure Zen has a minimal impact on your application's performance.

The benchmark runs a simple MongoDB query to measure the difference between two runs with and without Zen:

Without Zen With Zen Difference in ms
0.214ms 0.222ms +0.008ms

(Using Node.js 18.x and MongoDB 6.3.x. Results will vary depending on your hardware.)

See benchmarks for more information.

Bug bounty program

Our bug bounty program is public and can be found by all registered Intigriti users at: https://app.intigriti.com/researcher/programs/aikido/aikidoruntime

Contributing

See CONTRIBUTING.md for more information.

Code of Conduct

See CODE_OF_CONDUCT.md for more information.

Security

See SECURITY.md for more information.