静的分析スキャンのトラブルシューティング

AppScan 360°のスキャンのトラブルシューティングは、AppScan on Cloudのスキャンとは少し異なります。AppScan 360° の SAST スキャンの問題をトラブルシューティングするには、こちらのガイダンスに従ってください。

スキャンのトラブルシューティングはまずユーザーが行い、解決できない場合は管理者にエスカレーションします。トラブルシューティングの一般的なパスは次のとおりです。
  1. ユーザーはエラー・メッセージを確認します。
  2. ユーザーは一般的なエラー・ケースをレビューします。
  3. 問題が解決しない場合は、ユーザーはスキャン・ログをダウンロードし、管理者にエスカレーションします。
  4. 管理者は、ユーザーが提供した情報を調査します。
  5. 問題が解決しない場合は、管理者がHCLサポートにエスカレーションします。

ユーザー: エラー・メッセージを確認

AppScan Central Platform から失敗したスキャンのスキャン・ページに進みます。以下のいずれかの操作を実行します。
  • 「アプリケーション」 > (アプリケーション) > 「すべてのスキャンを表示」 > (スキャン名)の順に選択します。または、
  • 「スキャン」 > (スキャン名)を選択します。
スキャン・ページに表示されるエラー・メッセージを確認します。一般的なエラー・ケースについては、以下で説明します。
重要: スキャン ID と実行 ID を書き留めます。
  • スキャン ID は URL の一部です。/scans/ の後のストリングを探します。例えば、次の URL のスキャン ID は 6ecf4111-adf9-47a8-852b-625ff4c954ef です。
    < ASCP service URL>/70f7db22-1bea-4f55-babc-5668f1f723f4/scans/6ecf4111-adf9-47a8-852b-625ff4c954ef/scanOverview
  • 実行 ID は「概要」タブの「スキャンの詳細」の下に表示されます。

ユーザー: 一般的なエラー・ケースの確認

最もよくあるエラーは、次のとおりです。

オープン・ソース

エラー: スキャンに失敗しました。使用しているサブスクリプションでは、オープン・ソース・スキャンは実行できません。 
「オープン・ソース」スキャンを有効にするには、営業担当者にお問い合わせください。 
さらにサポートが必要な場合は、HCL のテクニカル・サポート・チームにお問い合わせください

オープン・ソース・ファイルをスキャンしようとしました。 AppScan 360° オープン・ソース・スキャンはサポートしていません。

スキャン用に ZIP ファイルをアップロードした場合は、ZIP ファイルの内容を確認します。

  • ZIP にオープン・ソース・ファイルのみが含まれている場合は、非オープン・ソース・ファイルを含む ZIP をアップロードして、スキャンを再試行します。
  • ZIP ファイルに appscan-config.xml 設定ファイルがある場合は、ファイルにリストされているプロパティーを確認します。 AppScan 360° openSourceOnly プロパティーをサポートしていません。openSourceOnly="true" が表示されている場合は、このプロパティーを削除してスキャンを再試行してください。
    注: appscan-config.xml でサポートされているプロパティーをこちらで確認します。
IRX をアップロードした場合:
  1. ターゲット・ファイルがオープン・ソース・ファイルでないこと、openSourceOnly パラメーターが使用されていないことを確認して、appscan prepare を再度実行します。
    注: appscan prepare でサポートされているパラメーターをこちらで確認します。
  2. 問題が解決しない場合は、スキャン・ログをダウンロードし、管理者にエスカレーションします

IPVA なし/破損した IRX

エラー: スキャンを正常に完了できません。IRX が正しく作成されなかったため、スキャンが失敗しました。 
設定が正しくないか、依存関係が欠落している可能性があります。 
さらにサポートが必要な場合は、HCL のテクニカル・サポート・チームにお問い合わせください。

スキャンの IRX 生成ステップ中に問題が発生しました。

IRX をアップロードした場合:

  • appscan prepare が実行された場所にアクセスできる場合は、そのプロセス中に作成された logs.zip ファイルにエラーがないかどうかを確認します。
  • SAClientUtil/logs/client.log ファイルでエラーを探します。
  • IRX の詳細な調査については、管理者にエスカレーションしてください

ZIP をアップロードした場合は、スキャン・ログをダウンロードし、管理者にエスカレーションします

不明なエラー

エラー。不明なエラーが発生しました。

いくつかの原因が考えられます。詳細を調査するため、スキャン・ログをダウンロードし、スキャン管理者にエスカレーションします

ユーザー: スキャン・ログをダウンロードし、管理者にエスカレーションする

スキャン・ログをダウンロードするには:
  • ASCP ユーザー・インターフェースからの場合
    1. スキャン・ページ (アプリケーション > アプリケーション > すべてのスキャンの表示 > (スキャン名) または スキャン > (スキャン名)) で、スキャンの詳細の下に表示されている実行 ID をコピーします。
    2. スキャン・ページの右上で、管理スキャン > ダウンロード・ログを選択します。

      AppScan 360° ZIP ファイルをローカル・システムにダウンロードします。ダウンロードの場所を書き留めておきます。

    3. ZIP ファイルの中のファイルを抽出します。
  • コマンド・ラインからの場合

    スキャンに関連付けられたディレクトリーの内容を、<fileStorageRoot>/SaaSWorkingDirectory/SaaSStorage/Scans/<scanID>/<ExecutionID}/ からダウンロードします。

スキャン管理者: ユーザー提供の情報を調査する

スキャン・ログへのアクセス

スキャン・ログにアクセスするには:

  1. スキャンに関連付けられたディレクトリーの内容を、<fileStorageRoot>/SaaSWorkingDirectory/SaaSStorage/Scans/<scanID>/<ExecutionID}/ からダウンロードします。
  2. ログを抽出して、エラーを調査します。
  3. エラーがあれば解決し、スキャンを再試行します。

IPVA なし/破損した IRX エラーが表示されている IRX を調査する

  1. スキャンに関連付けられたディレクトリーの内容を、<fileStorageRoot>/SaaSWorkingDirectory/SaaSStorage/Scans/<scanID>/<ExecutionID}/ からダウンロードします。
  2. ダウンロードしたファイルをローカル・システムにコピーします。
  3. 7-ZIP または同様のツールを使用して、IRX ファイルを右クリックし、「アーカイブを開く」をクリックします。

  4. Internal.scan をダブルクリックして開きます。

  5. ルートの .log ファイルとログ・フォルダーのログをチェックして、エラーがないか確認します。
  6. エラーがあれば解決し、スキャンを再試行します。

オープン・ソース・エラーのある IRX の調査

注: AppScan 360° オープン・ソース・スキャンはサポートしていません。
Your subscription does not allow for Open Source scans. (使用しているサブスクリプションではオープン・ソース・スキャンを実行できません。) というエラーでスキャンが失敗し、スキャンのために IRX をアップロードしている場合は、次の IRX ファイルにエラーがないことを確認します。
  1. スキャンに関連付けられたディレクトリーの内容を、<fileStorageRoot>/SaaSWorkingDirectory/SaaSStorage/Scans/<scanID>/<ExecutionID}/ からダウンロードします。
  2. 7-ZIP または同様のツールを使用して、IRX ファイルを右クリックし、「アーカイブを開く」をクリックします。

  3. scan.manifest ファイルを検査のために開きます。
    Total Languages Found = 1 であり、Language セクション内の唯一のエントリーが Open Source の場合、IRX ファイルはオープン・ソース・スキャン専用に生成されたか、次のオープン・ソース・ファイルしかない場所を指定したことを意味します。
    • ターゲット・ロケーションに非オープン・ソース・ファイルが含まれていることを確認します。

      AppScan 360° オープン・ソース・スキャンはサポートしていません。

    • appscan prepare コマンドまたは appscan-config.xml ファイルで、サポートされていないプロパティーまたはパラメーターを使用していないことを確認します。openSourceOnly="true" がある場合は、このプロパティーを削除します。

      AppScan 360° appscan prepare または appscan-config.xml openSourceOnly プロパティーをサポートしていません。

  4. スキャンを再試行してください。

その他のエラー・ケースの調査

オープン・ソース・ファイルの種類

検査中に問題が検出されました。 
準備操作ではオープン・ソース・ファイル・タイプのみが検出されました。オープン・ソースのみを実行するには -oso フラグを使用します。 
セキュリティーとオープン・ソースを実行するには、サポートされているファイル・タイプを追加します。

オープン・ソースのみのスキャンを実行しようとしたか、サードパーティー・スキャンを実行しようとしましたが、スキャンには追加の設定が必要です。

AppScan 360° オープン・ソースのみのスキャンはサポートしていません。

次のように、スキャン設定を確認します。
  • appscan prepare コマンドでサポートされていないパラメーターを使用していないことを確認します。openSourceOnly="true" または -oso が含まれている場合は、このパラメーターを削除します。

    AppScan 360° appscan prepareopenSourceOnly または -oso パラメーターをサポートしていません。

  • IRX をアップロードし、サードパーティー・ライブラリーのみがある場所でスキャンを実行する場合は、サードパーティー・スキャンを有効にします。以下のいずれかの操作を実行します。
    1. サードパーティー・フラグを appscan prepare に追加して、サードパーティー・ライブラリーを取得し、スキャンを再試行します。

      コマンドは appscan prepare-tp のようになります。

    2. thirdpart="true"appscan-config.xml に追加して、スキャンを再試行します。

      例については、CLI を使用した IRX ファイル生成の構成を参照してください。

  • ZIP をアップロードし、サードパーティー・ライブラリーのみがある場所でスキャンを実行する場合は、サードパーティー・スキャンを有効にします。
    • サードパーティーのコードをスキャンする場合は、thirdParty="true"appscan-config.xml に追加して、スキャンを再試行します。

既知のファイル・タイプがありません

ディスカバリー中に既知のスキャン・ファイル・タイプが検出されませんでした。 
.class、.jar、.war、.ear、.dll、.exe、PHP、Ruby、NPM のパッケージ、または JavaScript ファイルが含まれる場所を指定してください。

スキャン可能なファイルが含まれていない場所をスキャンしようとしました。

ターゲット・ロケーションにあるファイルが有効なファイル・タイプであることを確認します。サポートされているファイル・タイプのリストは、静的解析言語サポートで確認してください。

appscan-config.xml を使用した場合は、ターゲット・パスが有効な場所であることを確認します。

スキャン可能なファイルがありません

検査中に問題が検出されました。 
スキャン可能なファイルが見つかりませんでした。サードパーティー・コードをスキャンするには、--thirdParty オプションを使用して IRX ファイルを生成します。オープン・ソースをスキャンするには、-oso オプションを使用して IRX を生成します。サポートされているファイル・タイプのリストについては、https://help.hcl-software.com/appscan/ASoC/src_language_support.html#src_language_support__table_ylp_rn5_jw を参照してください。
  • サードパーティー・ライブラリーのみがある場所でスキャンを実行する場合は、サードパーティー・スキャンを有効にする必要があります。以下のいずれかの操作を実行します。
    1. サードパーティー・フラグを appscan prepare に追加して、サードパーティー・ライブラリーを取得し、スキャンを再試行します。

      コマンドは appscan prepare -tp のようになります。

    2. thirdpart="true"appscan-config.xml に追加して、スキャンを再試行します。

      例については、CLI を使用した IRX ファイル生成の構成を参照してください。

  • データ・フロー分析スキャンを実行する場合は、ターゲット・スキャンの場所に Java、.NET、または C/C++ 用の正しいコンパイル済みファイル・タイプが含まれていることを確認してから、スキャンを再試行してください。

  • ソース・コードのみのスキャンを実行する場合は、ターゲット・ロケーションに正しいソース・コード・ファイル・タイプが含まれていることを確認してから、スキャンを再試行してください。
  • ソース・コードのみのスキャンを実行しない場合は、appscan prepare コマンドまたは appscan-config.xml から –sco フラグを削除して、スキャンを再試行します。

スキャン管理者: HCL サポートとの連携

ここに記載されているトラブルシューティング・ガイダンスを適用した後も、スキャン・エラーの原因がわからない場合は、HCL カスタマーサポートにお問い合わせください。サポートに次の情報を提供できるようにします。
  • 実行 ID
  • スキャン ID
  • 準備ポッド ID (該当する場合)
  • アナライザ・ポッド ID (該当する場合)
  • AppScan 360° のスキャン・ページまたは service.log に報告されたエラー。
  • ログ ZIP ファイル。
  • スキャンするアプリケーション/プロジェクトの詳細。
  • 問題のトラブルシューティングあるいは解決のために実行された手順の詳細。
注: 重要な情報およびポッドからのスキャンの詳細のバックアップを安全な場所に保管します。ポッド上のデータは、デフォルトで 10 日後にクリーンアップされます。