OpenAPI 記述ファイルを使用したスキャン

OpenAPI 記述ファイルを使用して OpenAPI を自動的にスキャンできます。OpenAPI は、パラメーターを更新してすべてのエンドポイントを含めることで、スキャン範囲を改善します。これにより、より正確かつ完全なスキャンが保証され、API 全体の潜在的な問題を特定できます。

手順

  1. 「構成」 > 「API」に移動し、「OpenAPI」を選択します。
  2. 「OpenAPI 記述ファイル」を選択し、「記述ファイルの追加」をクリックします。
  3. URL を入力するか、「参照」をクリックしてローカル・ドライブからファイルを選択し、「続行」をクリックします。AppScan は、JSON または YAML 形式の記述ファイルのみ受け入れます。
    AppScan はデータを解析し、追加パラメーターの表にロードします。
  4. パラメーター値を関連する URL と一致するように編集して、自動スキャンのパフォーマンスを向上させます。
    スキャン中は、更新されたパラメーターのみが使用されます。したがって、スキャン範囲を改善するためにパラメーターを更新し、確実にすべてのエンドポイントを対象にして要求の失敗を回避することを強くお勧めします。
  5. 必要に応じて API 認証を構成します。記述ファイルに基づいて、認証を構成するための「API キーの構成」「基本認証 (HTTP) の構成」リンクが表示されます。リンクが表示されない場合は、API キーHTTP 認証、またはログイン管理を使用して認証を手動で構成できます。これにより、ほとんどのエンドポイントを対象とするスキャン範囲が改善され、要求の失敗が回避されるようになります。
  6. 構成が完了したら、スキャンを開始できます。
    自動スキャンが開始されます。
    注: 構成に URL ではなくローカル・ファイルを追加する場合、そのファイルを SCANT (テンプレート) ファイルとしてエクスポートできなくなるのは、記述ファイルをテンプレートに組み込めなくなるためです。記述ファイルを削除するか、SCAN ファイルとして保存する必要があります。

次のタスク

スキャンが完了すると、スキャン中に「フォームの自動入力」ページで検出されたパラメーターのほかに、送信済み要求や「データ」ページで検出されたパラメーターを表示できます。