Setup and Installation of Zen Firewall for PHP
This guide will walk you through installing and setting up Zen Firewall by Aikido for your application. Follow the steps below to protect your application.
We have first class support for multiple frameworks and database drivers, for the full list please check our README on GitHub.
Create an app in the dashboard and generate a token
Create your Aikido account if you haven't done so already
Go to the Zen section in Aikido.
Click on Add app.
Choose a name for your app and click Generate token.
Copy the generated token
Install Zen Firewall by Aikido
Zen Firewall for PHP comes as a single package that needs to be installed on the system to be protected.
Prerequisites:
Ensure you have sudo privileges on your system.
Make sure to use the appropriate commands for your system or cloud provider.
Managed platforms:
Environment specific instructions:
Start Zen Firewall in dry / detection-only mode
Set the token as an environment variable:
AIKIDO_TOKEN=YOUR_SECRET_TOKENStart your app in dry mode
AIKIDO_BLOCK=falseto ensure it works as expected without blocking any requests. We advise to run Aikido Zen in staging for two weeks to avoid any false positives.
Don't forget to restart PHP-FPM or your webserver to reload PHP with Zen
Test your app
Browse to your application and perform a couple of actions or open a couple of pages. Zen will automatically discover the routes in your application.
You can verify a working agent by looking at the following pages of your Zen application:
Events: Should show an "Application started" event.
Routes: After some time your application routes will start showing here with the method, route and requests.
Instances: Should show the number of active instances for your application where Zen is installed.
Enable Rate limiting and User blocking
Enable additional features like Rate limiting and User blocking from within your code by using the snippet below or the more specific framework examples on Github.
// Check if Aikido extension is loaded
if (extension_loaded('aikido')) {
// Get the user from your authentication middleware
// or wherever you store the user
\aikido\set_user("123", "John Doe");
// Check blocking decision from Aikido
// and decide on what to do
$decision = \aikido\should_block_request();
if ($decision->block) {
if ($decision->type == "blocked") {
if ($decision->trigger == "user") {
return response('Your user is blocked!', 403);
}
else if ($decision->trigger == "ip") {
return response("Your IP ({$decision->ip}) is blocked due to: {$decision->description}!", 403);
}
} else if ($decision->type == "ratelimited") {
if ($decision->trigger == "user") {
return response('Your user exceeded the rate limit for this endpoint!', 429);
}
else if ($decision->trigger == "ip") {
return response("Your IP ({$decision->ip}) exceeded the rate limit for this endpoint!", 429);
}
}
}
}Setup rate limiting in the dashboard
After you've added the Aikido middleware, you can test it out by logging in to your Aikido account and navigating to the Zen dashboard.
To protect a route from brute force attacks, set up rate limiting in the Aikido Dashboard:
Click on the created app.
Go to the Routes tab.
Find the route you would like to limit and click Setup rate limiting.
Follow the instructions to configure the rate limit (e.g., 5 requests per minute).
Verify Rate Limiting
Start your app and try to access the route you've rate limited 5 times within a minute. After the fifth attempt, you should receive a rate limit error:
Success & Next Steps
Congrats you've successfully installed Aikido Zen. If you encountered any problems, have concerns or have feature requests, don't hesitate to reach out to support.
You can now go and explore the many features that Zen provides:
Additional information:
Troubleshooting
Last updated
Was this helpful?