At the very beginning of your app.js file, add the following line:
require("@aikidosec/firewall"); // <-- Include this before any other code or imports
const { PubSub } = require("@google-cloud/pubsub");
const client = new PubSub();
const topic = client.createTopic("my-topic");
const subscription = topic.createSubscription("my-subscription");
subscription.on("message", (message) => {
console.log("Received message:", message.data.toString());
message.ack();
});
// ...
or ESM import style:
import "@aikidosec/firewall";
// ...
That's it! Your app is now protected by Aikido guard.
If you want to see a full example, check our Pub/Sub sample app.
By default, Zen will run in non-blocking mode. When Zen detects an attack, it will be reported to Aikido and continue executing the call.
You can enable blocking mode by setting the environment variable AIKIDO_BLOCK
to true
.
If you need to debug the firewall, you can run your consumer with the environment variable AIKIDO_DEBUG
set to true
.
This will output debug information to the console (e.g. if the agent failed to start, no token was found, unsupported packages, ...).
Zen can also protect your application against prototype pollution attacks.
Read Protect against prototype pollution to learn how to set it up.