スキャンレポート

レポートには、後から確認できるようにスキャン範囲、カバレッジ、検証結果、検出内容が保存されます。プロジェクトを手動で調べる場合は、HTML レポートから始めてください。

php scanner /var/www/example --lite --report-only

既定では、スキャナーは現在のディレクトリに scanner-report.html を書き込みます。--path-report=<path> で保存先を変更できます。

概要では、発見済み、対象、スキャン済み、キャッシュ済み、検証済み、スキップ済みのファイルを分けて表示します。これにより、対象プロジェクトが意図どおりカバーされたか確認できます。重大度ごとの合計は検出内容をまとめたものです。テキスト検索と重大度フィルターでファイル一覧を絞り込み、対応する前に各一致箇所をソースの文脈で確認してください。

レポートモード

オプション	動作
--report	レポートを保存し、対話的な操作を有効にする
--report-only, -r	レポートを保存し、対話的な操作を無効にする
--disable-report, --no-report	レポートの生成を停止する

スキャン対象のファイルを変更してはいけない初回スキャンや自動ジョブでは、--report-only を使用してください。

レポート形式

--report-format=<format> で形式を指定します。

形式	用途
html	ライト／ダークテーマ、検索、重大度フィルターに対応したブラウザーでの確認
txt	ターミナルやプレーンテキストのアーカイブ向けの移植可能な概要
json	スクリプトなどの自動処理向けの詳細な検出情報
sarif	Static Analysis Results Interchange に対応するツールへのインポート

たとえば、指定した場所に JSON レポートを作成します。

php scanner /var/www/example --lite --report-only \
  --report-format=json \
  --path-report=/var/reports/amwscan.json

最初にカバレッジを確認する

スキャナーが対象の一部をスキップすると、検出がなくてもレポートにその事実が現れます。結果をクリーンと判断する前に、カバレッジの合計とスキップ理由を確認してください。アーカイブ、読み取り不能なファイル、パスフィルター、拡張子、ファイルサイズの制限によってカバレッジが低下することがあります。

レポートにはローカルパスや一致したコードが含まれる場合があります。ビルド成果物として保存したり他のレビュアーと共有したりする場合は、公開ドキュメントルートの外に保管し、アクセスを制限してください。

すべてのレポートとログのオプションについては CLI コマンドリファレンス を参照してください。