@aikidosec/firewall

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

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 scanning user input and where that data eventually flows to, allowing Zen to more accurately block SQL Injections, Path traversal attacks, and more. 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:

• 🛡️ NoSQL injection attacks
• 🛡️ SQL injection attacks
• 🛡️ Command injection attacks
• 🛡️ Prototype pollution
• 🛡️ Path traversal attacks
• 🛡️ Server-side request forgery (SSRF)
• 🛡️ Attack wave detection
• 🛡️ JS injection

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.
• ✅ Auto-generate API specifications
• ✅ Block known threat actors and bots.
• ✅ Geo-fencing to block or allow a selection of countries
• ✅ Rate limit specific API endpoints by IP or by user
• ✅ Allows you to block specific users manually

Supported libraries and frameworks

Zen for Node.js 16+ is compatible with:

Web frameworks

• ✅ Express 4.x, 5.x
• ✅ Hono 4.x
• ✅ hapi 21.x
• ✅ micro 10.x
• ✅ Next.js 12.x, 13.x and 14.x
• ✅ Fastify 4.x and 5.x
• ✅ Koa 3.x and 2.x
• ✅ NestJS 10.x and 11.x
• ✅ Restify 11.x, 10.x, 9.x and 8.x

Database drivers

• ✅ mongodb 4.x, 5.x and 6.x (npm package versions, not MongoDB server versions)
• ✅ mongoose 8.x, 7.x and 6.x
• ✅ pg 8.x and 7.x
• ✅ mysql 2.x
• ✅ mysql2 3.x
• ✅ mariadb 3.x
• ✅ sqlite3 5.x
• ✅ node:sqlite
• ✅ better-sqlite3 12.x, 11.x, 10.x, 9.x and 8.x
• ✅ postgres 3.x
• ✅ @clickhouse/client 1.x
• ✅ @prisma/client 5.x

Cloud providers

• ✅ @google-cloud/functions-framework 4.x, 3.x
• ✅ @google-cloud/pubsub 5.x, 4.x
• ✅ Google Cloud Functions
• ✅ AWS Lambda

ORMs and query builders

See list above for supported database drivers.

• ✅ sequelize
• ✅ knex
• ✅ typeorm
• ✅ bookshelf
• ✅ drizzle-orm

API tools

• ✅ graphql 16.x

Data serialization tools

• ✅ xml2js 0.6.x, 0.5.x, ^0.4.18
• ✅ fast-xml-parser 5.x, 4.x
• ✅ xml-js 1.x

Shell tools

• ✅ ShellJS 0.9.x, 0.8.x, 0.7.x

Routers

• ✅ @koa/router 14.x, 13.x, 12.x, 11.x and 10.x

AI SDKs

Zen instruments the following AI SDKs to track which models are used and how many tokens are consumed, allowing you to monitor your AI usage and costs:

• ✅ openai 5.x, 4.x
• ✅ @mistralai/mistralai 1.x
• ✅ @anthropic-ai/sdk ^0.40.x
• ✅ @aws-sdk/client-bedrock-runtime 3.x
• ✅ ai 5.x, 4.x
• ✅ @google/genai ^1.6.0

Note: Prompt injection attacks are currently not covered by Zen.

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:

• Express
• Fastify
• Hapi
• Koa
• Hono
• NestJS
• micro
• Next.js
• Restify
• AWS Lambda
• Google Cloud Functions
• Google Cloud Pub/Sub

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 improves Aikido's offering by providing you with security in production. Use the automatic generation of API specifications together with our API scanning offering for even better API Security.

Only the necessary data gets reported back to Aikido, we scan your requests locally and only report back data once every 10 minutes. If an attack on your application is detected, we report immediately allowing you to take swift action.

You can easily select which IP addresses and/or bots to block from curated lists inside our Dashboard.

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. (No credit card required)

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.

Additional configuration

Configure Zen using environment variables for authentication, mode settings, debugging, and more.

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: [e-mail] or create an account at https://app.aikido.dev.

Benchmarks

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

See benchmarks

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.