API Discoveryのセットアップ ¶

この記事では、API Discoveryモジュールを有効化、構成、デバッグする方法を説明します。

有効化¶

API Discoveryは、Wallarmノードのインストール形態のうち、自己ホスト型、Security Edge、およびConnectorのすべてに含まれています。ノードのデプロイ時にAPI Discoveryモジュールはインストールされますが、デフォルトでは無効になっています。

API Discoveryを正しく有効化して動作させるには、次の手順を実行します。

サブスクリプションプランにAPI Discoveryが含まれていることを確認します。サブスクリプションプランを変更するには、sales@wallarm.comまでリクエストを送信してください。
Wallarm Console → API Discovery → Configure API Discoveryで、API Discoveryによるトラフィック解析を有効化します。

API Discoveryモジュールを有効化すると、トラフィック解析とAPIインベントリの構築が開始されます。APIインベントリはWallarm ConsoleのAPI Discoveryセクションに表示されます。

API DiscoveryセクションのConfigure API Discoveryボタンをクリックすると、API Discoveryの微調整オプション（API Discoveryの対象アプリケーションの選択やリスクスコア計算のカスタマイズなど）に進みます。

すべてのアプリケーション、または選択したアプリケーションに対してのみAPI Discoveryを有効化または無効化できます。

アプリケーションがアプリケーションの設定の記事の説明どおりに追加されていることを確認します。

アプリケーションが設定されていない場合、すべてのAPIの構造は1つのツリーにまとめられます。
Wallarm Console → API Discovery → Configure API Discoveryで、必要なアプリケーションに対してAPI Discoveryを有効化します。

Settings → Applicationsで新しいアプリケーションを追加すると、disabledの状態でAPI Discoveryの対象アプリケーション一覧に自動的に追加されます。

リスクスコアの計算における各要素の重みや計算方法を設定できます。

API Discoveryは、APIで扱われる機密データを検出してハイライト表示します。既存の検出プロセスを微調整し、検出対象を独自のデータ型で拡張できます。

現在の構成を表示して変更するには、Wallarm ConsoleでAPI Discovery → Configure API Discovery → Sensitive dataに移動します。ここでは、既存の機密データパターンの確認と変更、独自パターンの追加ができます。

API Discoveryのログを取得して分析するには、ノードが稼働しているLinuxマシン上のログファイル/opt/wallarm/var/log/wallarm/appstructure-out.logを参照できます。