OpenAPI 仕様ファイルを使用したスキャン
OpenAPI 仕様ファイルを使用して OpenAPI を自動的にスキャンできます。これにより、パラメーターを更新してすべてのエンドポイントを含めることができるため、より適切なカバレッジが得られます。これにより、より正確で完全なスキャンが保証されます。
始める前に
注: パラメーター値がアップロード済みファイルの場合は、Postman コレクションを使用したスキャンを使用します。
手順
- 「構成」>「API」に移動します。
-
「OpenAPI 仕様ファイル」を選択し、「仕様ファイルを追加」をクリックします。
注: AppScan Standard は、OpenAPI 仕様バージョン「3.1.0」をサポートしていません。
-
URL を入力するか、「参照」をクリックしてローカル・ドライブからファイルを選択し、「続行」をクリックします。AppScan は、仕様ファイルの JSON または YAML 形式のみを受け入れます。
AppScan は仕様ファイルを解析し、検出された API パラメーターを「追加パラメーターの編集」テーブルに表示します。
- 自動的に入力されない場合は、ベース URL を設定します。
-
AppScan は探査中にパラメーターの値を自動的に検出しますが、スキャン中に値が自動的に検出できない場合には、パラメーターを手動で更新してパフォーマンスを向上させることができます。パラメーター値を関連する URL と一致させて編集します。
注: パラメーター名と値がすべてのエンドポイントに適用される場合は、「パラメーターの編集」ダイアログで「この値をすべてのパラメーターに適用」チェックボックスを選択します。スキャン範囲を改善するためにパラメーターを更新し、すべてのエンドポイントがカバーされていることを確認して、要求の失敗を回避することをお勧めします。
- 必要に応じて API 認証を設定します。仕様ファイルに基づいて、「API キーの設定」または「基本認証の構成 (HTTP)」リンク (あるいはこの両方) が表示され、認証を設定できます。リンクが表示されない場合は、API キー、HTTP 認証、またはログイン管理 (ログインを記録または自動ログインを使用) を使用して、認証を手動で構成できます。
- 探査中に速度制限を超過するエラーが発生しないようにするには、「通信およびプロキシー」タブで「最大要求速度」を調整します。
-
構成が完了したら、スキャンを開始できます。
AppScan は自動スキャンを開始します。注: URL の代わりにローカル・ファイルを構成に追加すると、その仕様ファイルをテンプレートに含めることができなくなるため、そのファイルを SCANT (テンプレート) ファイルとしてエクスポートすることはできません。その仕様ファイルを削除するか、SCAN ファイルとして保存する必要があります。