Setup and Installation of Zen Firewall for Python

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 check our README on GitHub.

Install Zen Firewall by Aikido

Zen Firewall for Python comes as a PIP package that needs to be installed together with your code so your application can be protected.

pip install aikido_zen

Choose your framework or runtime and follow the specific instructions.

Django

In manage.py add the following snippet to your application

import os
import sys
import aikido_zen

if __name__ == "__main__":
    aikido_zen.protect()
    # ...

For more advanced options check out our Github docs.

Gunicorn

Use the following template for your gunicorn_config.py file:

import aikido_zen.decorators.gunicorn as aik

@aik.post_fork
def post_fork(server, worker):
    # If you already have a config file, replace pass with your own code.
    pass

Modify your gunicorn starting command to add this configuration file:

gunicorn -c gunicorn_config.py --workers ...

For more advanced options check out our Github docs.

Quart

In app.py add the following snippet to your application

import aikido_zen
aikido_zen.protect()

When installing additional middleware, make sure to install it like this and not like app.asgi_app = my_middleware as it would remove all other middleware.
from quart import Quart
app = Quart(__name__)
...
app.asgi_app = my_middleware(app.asgi_app)

For more advanced options check out our Github docs.

Flask, Starlette, FastAPI, uWSGI

In app.py add the following snippet to your application

import aikido_zen
aikido_zen.protect()

For more advanced options check out our Github docs.

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

Start Zen Firewall in dry / detection-only mode

Set the token as an environment variable: AIKIDO_TOKEN=YOUR_SECRET_TOKEN
Start your app in dry mode AIKIDO_BLOCK=false to 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.

You can use AIKIDO_DEBUG=true to enable debug mode for more detailed information about what the agent is doing. For more information about your environment variables: Configuration via environment variables

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 relevant framework snippets below.

Django

In settings.py add the following snippet to your application to enable request blocking

MIDDLEWARE = [
    # Authorization middleware here (Make sure aikido middleware runs after this)
    "aikido_zen.middleware.AikidoDjangoMiddleware",
    # ...
]

To more easily identify your users in the Zen UI, use the following helper function within your authentication middleware after you've authenticated your user.

from aikido_zen import set_user

# Set a user (presumably in middleware) :
set_user({"id": "123", "name": "John Doe"})

Flask

In your main file add the following snippet to your application to enable request blocking

from aikido_zen.middleware import AikidoFlaskMiddleware

app = Flask(__name__)
# ...
app.wsgi_app = AikidoFlaskMiddleware(app.wsgi_app)
# Authorization middleware here (Make sure aikido middleware runs after this) 
# Flask runs from bottom to top
# ...

To more easily identify your users in the Zen UI, use the following helper function within your authentication middleware after you've authenticated your user.

from aikido_zen import set_user

# Set a user (presumably in middleware) :
set_user({"id": "123", "name": "John Doe"}

Starlette / FastAPI

In your main file add the following snippet to your application to enable request blocking

from starlette.middleware import Middleware
from aikido_zen.middleware import AikidoStarletteMiddleware

app = Starlette(routes=[
    ...
], middleware=[
    ...
    # Authorization middleware here (Make sure aikido middleware runs after this)
    Middleware(AikidoStarletteMiddleware),
    ...
])

To more easily identify your users in the Zen UI, use the following helper function within your authentication middleware after you've authenticated your user.

from aikido_zen import set_user

# Set a user (presumably in middleware) :
set_user({"id": "123", "name": "John Doe"})

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:

You are rate limited by Aikido firewall. (Your IP: 1.2.3.4)

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:

Last updated 2 months ago

Was this helpful?

hashtagInstall Zen Firewall by Aikido

hashtagDjango

hashtagGunicorn

hashtagQuart

hashtagFlask, Starlette, FastAPI, uWSGI

hashtagCreate an app in the dashboard and generate a token

hashtagStart Zen Firewall in dry / detection-only mode

hashtagTest your app

hashtagEnable Rate limiting and User blocking

hashtagDjango

hashtagFlask

hashtagStarlette / FastAPI

hashtagSetup rate limiting in the dashboard

hashtagSuccess & Next Steps

Install Zen Firewall by Aikido

Django

Gunicorn

Quart

Flask, Starlette, FastAPI, uWSGI

Create an app in the dashboard and generate a token

Start Zen Firewall in dry / detection-only mode

Test your app

Enable Rate limiting and User blocking

Django

Flask

Starlette / FastAPI

Setup rate limiting in the dashboard

Success & Next Steps