> For the complete documentation index, see [llms.txt](https://help.aikido.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aikido.dev/docs/docs-ja/zen-firewall/zen-installation-instructions/zen-firewall-for-python/quart.md). # Python（Quart） このガイドでは、アプリケーション向けに Aikido の Zen Firewall をインストールして設定する手順を案内します。アプリケーションを保護するには、以下の手順に従ってください。 問題やトラブルが発生した場合は、サポートチャットまたは GitHub の Issue から遠慮なくお問い合わせください ## 要件 * Python 3.8+（3.13 までサポート）。 * Quart（Zen Firewall に対応）。 * [Aikido アカウント](/docs/docs-ja/hajimeni/setting-up-your-account.md) & [Zen Firewall トークン](/docs/docs-ja/zen-firewall/zen-installation-instructions/creating-an-aikido-zen-firewall-token.md) ## インストールと設定 {% stepper %} {% step %} **Aikido による Zen Firewall のインストール** pip で Zen をインストールします: ```bash pip install aikido_zen ``` トークンの環境変数を設定します: ```bash export AIKIDO_TOKEN=AIK_RUNTIME_YOUR_TOKEN_HERE ``` 可能であれば、エントリポイントの先頭で、他のインポートより前に Zen を有効にします: ```python import aikido_zen aikido_zen.protect() ``` ```python import aikido_zen aikido_zen.protect() ``` {% endstep %} {% step %} **リクエストのブロックとユーザー識別を有効にする** このミドルウェアを使用して、レート制限、ユーザー識別、およびブロック機能を有効にします。 Zen Firewall が攻撃をブロックするためにこのミドルウェアを必要とすることはありません。コアの攻撃防御はこれがなくても機能します。このミドルウェアは、Zen が次のような保護に使用する追加のリクエストコンテキストを提供します。 [レート制限](/docs/docs-ja/zen-firewall/zen-features/setting-up-rate-limiting-for-routes.md), [ユーザーブロック](/docs/docs-ja/zen-firewall/zen-features/blocking-users-with-zen-firewall.md), [ボットのブロック](/docs/docs-ja/zen-firewall/zen-features/blocking-bot-traffic-with-zen-firewall.md), [国別ブロック](/docs/docs-ja/zen-firewall/zen-features/blocking-traffic-by-country-with-zen-firewall.md)、 [脅威アクター](/docs/docs-ja/zen-firewall/zen-features/blocking-known-threat-actors-with-zen-firewall.md) ブロック。 アプリケーションがユーザーを識別し、リクエストを処理する方法に合わせて、例を調整してください。 既存の ASGI アプリをラップしてミドルウェアを導入します: ```python from quart import Quart from aikido_zen.middleware import AikidoQuartMiddleware app = Quart(__name__) app.asgi_app = AikidoQuartMiddleware(app.asgi_app) ``` 認証後にユーザーを設定します: ```python from aikido_zen import set_user set_user({"id": "123", "name": "John Doe"}) ``` {% endstep %} {% step %} **Zen Firewall をドライ / 検知専用モードで起動する** コマンド例: ```bash AIKIDO_BLOCK=false AIKIDO_TOKEN=YOUR_SECRET_TOKEN quart run ``` トークンを環境変数として設定し、Aikido Zen エージェントがそれを取得できるようにします。まだトークンがない場合は、次に従ってください [こちらの手順](/docs/docs-ja/zen-firewall/zen-installation-instructions/creating-an-aikido-zen-firewall-token.md). ```bash AIKIDO_TOKEN=AIK_RUNTIME_ ``` リクエストをブロックせずに期待どおりに動作することを確認するため、アプリは dry モードで起動することをおすすめします。誤検知を避けるため、Zen Firewall はステージング環境で 2 週間実行することを推奨します。 ```bash AIKIDO_BLOCK=false ``` {% hint style="info" %} 次を使用できます `AIKIDO_DEBUG=true` エージェントの動作についてより詳細な情報を得るために、デバッグモードを有効にします。環境変数の詳細については: [環境変数による設定](/docs/docs-ja/zen-firewall/zen-installation-instructions/configuration-via-environment-variables.md) {% endhint %} {% endstep %} {% step %} **アプリをテストする** アプリケーションを閲覧し、いくつかの操作を行うか、いくつかのページを開いてください。Zen がアプリケーション内のルートを自動的に検出します。 {% hint style="info" %} Zen は 10 分ごとにデータを Aikido に送信します {% endhint %} 次の Zen アプリケーションのページを確認することで、エージェントが正常に動作しているかを確認できます: * **イベント**: 「Application started」イベントが表示されるはずです。 * **ルート**: しばらくすると、アプリケーションのルートがメソッド、ルート、リクエストとともにここに表示され始めます。 * **インスタンス**: Zen がインストールされているアプリケーションのアクティブなインスタンス数が表示されるはずです。
{% endstep %} {% step %} **ダッシュボードでレート制限を設定する** Zen Firewall ミドルウェアを追加したら、Aikido ダッシュボードでレート制限を設定することで、ブルートフォース攻撃からルートを保護できるかをテストできます。 1. 作成したアプリをクリックしてください。 2. 次の **ルート** タブ。 3. 制限したいルートを見つけて、クリックしてください **レート制限を設定する**. 4. 指示に従ってレート制限を設定します（例: 1 分あたり 5 リクエスト）。 ![認証ルートに保護とレート制限のオプションを表示する API ルート管理インターフェース。](/files/e261faad47cc6b8291385535f551e58938a77367) ![POST /auth/login のレート制限を 1 分あたり 5 リクエストに設定します。](/files/532f8ebb75a40ac740e8c3d35685a3aeb1b7e97d) **レート制限を確認する** アプリを起動し、レート制限を設定したルートに 1 分以内に 5 回アクセスしてみてください。5 回目の試行の後、レート制限エラーが表示されるはずです: ``` Aikido ファイアウォールによりレート制限されています。（あなたの IP: 1.2.3.4） ``` {% endstep %} {% step %} **次のステップ** Zen Firewall のインストールに成功しました。おめでとうございます。問題やご不明点、機能のリクエストがある場合は、遠慮なくサポートまでご連絡ください。 これで、Zen Firewall が提供する多彩な機能をぜひご覧いただけます: * [Zen Firewallでボットトラフィックをブロック](/docs/docs-ja/zen-firewall/zen-features/blocking-bot-traffic-with-zen-firewall.md) * [Zen FirewallでTorトラフィックをブロックまたは監視](/docs/docs-ja/zen-firewall/zen-features/blocking-tor-traffic-with-zen-firewall.md) * [Zen Firewallでユーザーを追跡](/docs/docs-ja/zen-firewall/zen-features/blocking-users-with-zen-firewall.md) * [Zen Firewallで既知の脅威アクターをブロック](/docs/docs-ja/zen-firewall/zen-features/blocking-known-threat-actors-with-zen-firewall.md) * [Zen Firewallで国別にトラフィックをブロック](/docs/docs-ja/zen-firewall/zen-features/blocking-traffic-by-country-with-zen-firewall.md) * [ルートのレート制限を設定](/docs/docs-ja/zen-firewall/zen-features/setting-up-rate-limiting-for-routes.md) * [外向きドメインを監視](/docs/docs-ja/zen-firewall/zen-features/monitor-outbound-domains.md) 追加情報: * [Zenのパフォーマンスと信頼性](/docs/docs-ja/zen-firewall/miscellaneous/how-zen-works-performance-reliability.md) * [Zen Firewallのブロックモードと検知モード](/docs/docs-ja/zen-firewall/zen-features/blocking-vs-detection-mode-in-zen-firewall.md) * [Zen統計を理解する](/docs/docs-ja/zen-firewall/zen-features/understanding-your-zen-statistics.md) {% endstep %} {% endstepper %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://help.aikido.dev/docs/docs-ja/zen-firewall/zen-installation-instructions/zen-firewall-for-python/quart.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.