Ruby on Rails

このガイドでは、アプリケーション向けに Aikido の Zen Firewall をインストールしてセットアップする手順を説明します。以下の手順に従って、アプリケーションを保護してください。

問題や不具合が発生した場合は、遠慮なくサポートチャットまたは Github issues でお問い合わせください。

https://github.com/AikidoSec/firewall-ruby

要件

Ruby 2.7以上
Ruby on Rails 7.xまたは8.x
AikidoアカウントとZen Firewallトークン

インストールと設定

1
Zen Firewall by Aikidoをインストールする

RubyアプリにZenをインストールします：
```
bundle add aikido-zen
```
config/application.rb内で、Bundler.requireの前にZenをrequireします：
```
require "aikido-zen"
Aikido::Zen.protect!

Bundler.require(*Rails.groups)
```
2
リクエストのブロックとユーザー識別を有効にする

このミドルウェアを使用すると、現在のユーザーを識別し、ユーザーブロックなどのユーザーベースの機能を有効にできます。

Zen Firewall が攻撃をブロックするために、このミドルウェアは必須ではありません。コアとなる攻撃防御機能は、このミドルウェアなしでも動作します。どのユーザーがリクエストを送信しているかを Zen に認識させたい場合に、このミドルウェアを追加してください。

アプリケーションでのユーザーの識別方法に合わせて、例を調整してください。
```
# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
  private

  def authenticate_user!
    # your authentication logic
    # ...

    Aikido::Zen.set_user(
      id: current_user.id,
      name: current_user.name
    )
  end
end
```
3
Zen Firewallをドライ/検出専用モードで起動する
```
AIKIDO_BLOCK=false AIKIDO_TOKEN=AIK_RUNTIME_ bundle exec rails s
```
Aikido Zen エージェントがトークンを読み取れるように、トークンを環境変数として設定してください。まだトークンをお持ちでない場合は、こちらの手順に従ってください。
```
AIKIDO_TOKEN=AIK_RUNTIME_
```
リクエストをブロックせずにアプリが期待どおりに動作することを確認するため、まずはドライモードでアプリを起動することをお勧めします。誤検知を避けるため、Zen Firewall をステージング環境で2週間実行することをお勧めします。
```
AIKIDO_BLOCK=false
```
AIKIDO_DEBUG=true を使用するとデバッグモードが有効になり、エージェントの動作に関するより詳細な情報を確認できます。環境変数の詳細については、こちらをご覧ください: configuration-via-environment-variables.md

トークンに暗号化されたcredentialsを使用したい場合：
```
# config/credentials.yml.enc
zen:
  token: "AIKIDO_RUNTIME_..."
```
```
# config/initializers/zen.rb
Rails.application.config.zen.token = Rails.application.credentials.zen.token
```
4
アプリをテストする

アプリケーションにアクセスし、いくつかの操作を行うか、いくつかのページを開いてください。Zen はアプリケーション内のルートを自動的に検出します。

Zen は 10 分ごとに Aikido へデータを送信します

Zen アプリケーションの以下のページを確認することで、エージェントが正常に動作していることを確認できます。
- Events: 「Application started」イベントが表示されているはずです。
- Routes: しばらくすると、アプリケーションのルートがメソッド、ルート、リクエストとともにここに表示され始めます。
- Instances: Zen がインストールされているアプリケーションのアクティブなインスタンス数が表示されているはずです。
5
ダッシュボードでレート制限を設定する

Zen Firewall ミドルウェアを追加したら、ルートをブルートフォース攻撃から保護する機能をテストできます。これは、Aikido Dashboard でレート制限を設定することで行います：
1. 作成したアプリをクリックします。
2. Routes タブに移動します。
3. 制限したいルートを見つけて、Setup rate limiting をクリックします。
4. 手順に従ってレート制限を設定します（例：1 分あたり 5 リクエスト）。
レート制限の確認

アプリを起動し、レート制限を設定したルートに 1 分以内に 5 回アクセスしてみてください。5 回目の試行の後、レート制限エラーが返されるはずです：
```
You are rate limited by Aikido firewall. (Your IP: 1.2.3.4)
```
6
次のステップ

Zen Firewall のインストールが完了しました。問題が発生した場合や、ご不明な点、機能のご要望がある場合は、お気軽にサポートまでお問い合わせください。

Zen Firewall が提供するさまざまな機能をぜひご覧ください：
その他の情報：