環境変数による設定
AIKIDO_TOKEN 環境変数を使って、Aikidoで生成したトークンを設定します。
AIKIDO_TOKEN="token"Blocking Mode
Section titled “Blocking Mode ”AIKIDO_BLOCK 環境変数を使うと、Blocking Modeを有効にできます。
AIKIDO_BLOCK="true"ダッシュボードでもBlocking ModeとDetection Modeを切り替えることができます。環境変数は開始時のモードとして使用されます。設定が取得されると、Zenはダッシュボードで設定されたモードへ切り替わります。
エージェントを無効にする
Section titled “エージェントを無効にする ”AIKIDO_DISABLE 環境変数を使うと、Zenを完全に無効化できます。万が一Zenが問題を引き起こした場合でも、コードや環境変数(AIKIDO_TOKEN など)を削除することなくZenを無効化できます。
AIKIDO_DISABLE="true"AIKIDO_DEBUG 環境変数を使うと、以下のようなより詳細な情報を出力できます。
- 特定のパッケージがサポートされているかどうか
- トークンが検出されたかどうか
- ZenがDetection Modeで動作しているかどうか
AIKIDO_DEBUG="true"プロキシ設定
Section titled “プロキシ設定 ”AIKIDO_TRUST_PROXY 環境変数を使うと、プロキシを信頼する設定ができます。
デフォルトでは、trust proxyは有効です。
AIKIDO_TRUST_PROXY="false"インスタンス名の上書き
Section titled “インスタンス名の上書き ”AIKIDO_INSTANCE_NAME は、アプリケーションインスタンスにカスタム名を設定します。ホスト名だけでは分かりにくい場合(コンテナ環境や一時的な環境など)に便利です。デフォルトはホスト名です。
AIKIDO_INSTANCE_NAME="custom-name"APIディスカバリのサンプル数を制限する
Section titled “APIディスカバリのサンプル数を制限する ”ルートごとに収集するリクエストサンプルの数を制限します。各サンプルには以下が含まれます。
- リクエストボディの構造と型(GraphQL以外のリクエストの場合)
- クエリパラメータ
- 使用された認証方式
これらのサンプルは、想定されるリクエスト形式や認証要件を含め、APIの構造を分析・文書化するのに役立ちます。
AIKIDO_MAX_API_DISCOVERY_SAMPLES="10"リクエストボディの最大サイズ(NodeJS)
Section titled “リクエストボディの最大サイズ(NodeJS) ”受信するHTTPリクエストボディの最大サイズ(MB単位)を設定します。この上限により、極端に大きなリクエストによるメモリ枯渇からアプリケーションを保護できます。
AIKIDO_MAX_BODY_SIZE_MB="10" # MB