@aikidosec/runtime

Aikido Runtime for Node.js

Runtime is an embedded security engine for autonomously protecting Node.js apps against common and critical attacks.

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

Features

Runtime autonomously protects your Node.js applications against:

• 🛡️ NoSQL injection attacks
• 🛡️ SQL injection attacks
• 🛡️ Command injection attacks
• 🛡️ Prototype pollution
• 🛡️ Path traversal attacks
• 🚀 More to come (see the public roadmap)!

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

• ✅ Secure your database similar to a web application firewall (WAF) with none of the infrastructure or cost.
• ✅ Minimize impact on production with a tiny footprint and no additional dependencies.
• ✅ Support a developer-first local development and testing experience.
• ✅ Save security operators and development teams hours rooting out vulnerabilities, testing exploits, and coding remediations.

Supported libraries and frameworks

Aikido Runtime for Node.js 16+ is compatible with:

Web frameworks

• ✅ Express 4.x
• ✅ Hono 4.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

Cloud providers

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

ORMs and query builders

See list above for supported database drivers.

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

Installation

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

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

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

• Express.js-based apps
• AWS Lambda
• Google Cloud Functions
• Google Cloud Pub/Sub

Reporting to your Aikido Security dashboard

Aikido Security is a developer-first software security platform. We scan your source code & cloud to show you which vulnerabilities are actually important.

You can use some of Runtimes's features without Aikido, 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 Runtime.
• Go to services.
• Click on Add service.
• Choose a name for your service.
• 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, Runtime will only detect and report attacks to Aikido.

To block requests, set the AIKIDO_BLOCKING 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 Aikido Runtime 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.

Performance

We run a benchmark on every commit to ensure Runtime 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 Runtime:

Without Runtime	With Runtime	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.

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.