構成コマンド (Windows™)

構成コマンドを使用して、スキャンするファイルを準備します。

appscan prepare

構文:

appscan prepare -c <configuration_file> -d <save_path> -jdk <jdk_path> -l <log_path> -n <file_name> -oso,--openSourceOnly

説明:

IRX ファイルを生成します。

注: コードをスキャンするか、IRX ファイルを生成する際に、最新の Static Analyzer コマンド行ユーティリティー への更新に関するメッセージを受け取ることがあります。「コマンド行ユーティリティー (CLI) のサポート」を参照してください。

オプションのフラグ/設定:

  • -c: このオプションは、スキャンの構成に使用します。
  • -d: -d <save_path> と指定します。<save_path> には IRX ファイルの保存先ディレクトリーが入ります。
  • -dr, --dryrun: -dr or --dryrun を指定してスキャン対象を見つけて検証しますが、.irx ファイルは生成しません。
  • -jdk: -jdk <jdk_path> と指定して、デフォルトの JDK 17 の代わりに使用される JDK インストールへのパスを指定します。構成ファイル (-c <configuration_file>) と jdk_path 属性の両方を使用した場合は、構成ファイルで指定された値が優先されます。
  • -l: -l <log_path> と指定します。<log_path> にはログ・ファイルの保存先ディレクトリーが入ります。
  • -n: -n <file_name> と指定します。<file_name> には IRX ファイルの名前が入ります。ファイル名を指定する際に、ファイル拡張子 .irx は付けても付けなくてもかまいません。ファイル拡張子なしで指定すると、ファイル生成時に自動的に拡張子が付けられます。
  • -oso, -openSourceOnly: SCA パッケージで既知の脆弱性のみを探すには、-oso または -openSourceOnly を指定します。-oso または -openSourceOnly を指定した場合、AppScan on Cloud はパッケージでの静的分析を実行しません。
    注: ユーザーがオープン・ソース・ライセンスを持っている場合、SCA 分析はデフォルトで静的スキャンに含まれます。このオプションでは、分析が SCA の脆弱性に限定されます。SCA のみの分析を利用するには、オープン・ソース・ライセンスを持っている必要があります。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

この構成ファイル (c:\my_config_files\my_config.xml) を使用し、IRX ファイルを c:\my_irx_files\my_scan.irx に保存する IRX ファイルを生成するには、次のコマンドを発行します。

appscan prepare -c c:\my_config_files\my_config.xml -d c:\my_irx_files -n my_scan.irx

appscan prepare_sca

構文:

appscan prepare_sca -d <save_path> -l <log_path> -n <file_name> -X, -debug -container <container> -image <image>

説明:

ソフトウェア・コンポジション分析 (SCA) を実行するための Docker イメージに対して IRX ファイルを生成します。パラメーターを指定せずに実行した場合、このコマンドは appscan prepare -oso を実行したのと同じになります。
重要: Docker コンテナーとイメージをスキャンするには、システムに Docker CLI ツールをインストールして構成する必要があります。

オプションのフラグ/設定:

  • -d: -d <save_path> と指定します。<save_path> には IRX ファイルの保存先ディレクトリーが入ります。
  • -l: -l <log_path> と指定します。<log_path> にはログ・ファイルの保存先ディレクトリーが入ります。
  • -n: -n <file_name> と指定します。<file_name> には IRX ファイルの名前が入ります。ファイル名を指定する際に、ファイル拡張子 .irx は付けても付けなくてもかまいません。ファイル拡張子なしで指定すると、ファイル生成時に自動的に拡張子が付けられます。
  • -X,--debug: -X または --debug を指定すると、デバッグ・モードでコマンド全体が実行されます。デバッグ・モードで実行すると、トラブルシューティング用のログ・ファイルがより多く生成されます。
  • -container: -container <container> と指定します。<container> は、分析する Docker コンテナーです。値には、コンテナー名、コンテナー・ダイジェスト、またはローカル・アーカイブへのパスを指定できます。
  • -image: -image <image> と指定します。<image> は、分析する Docker イメージです。値には、イメージ名、イメージ・ダイジェスト、またはローカル・アーカイブへのパスを指定できます。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

appscan get_pubkey

構文:

appscan get_pubkey -d <save_path>

説明:

インターネットに接続されていないコンピューターで使用するために、公開暗号鍵をダウンロードします。

インターネットに接続されているコンピューターから IRX ファイルを生成している場合は、prepare コマンドを発行するときに暗号鍵が自動的にダウンロードされるため、このコマンドは不要です。コンピューターに暗号鍵が既に存在する場合は、prepare コマンドを発行すると、必要に応じて暗号鍵が更新されます。

ただし、インターネットに接続されていないコンピューターから IRX ファイルを生成している場合は、このコマンドを使用して暗号鍵をダウンロードできます。その後、IRX ファイルの生成時に使用するために、インターネットに接続されていないコンピューターに暗号鍵をコピーできます。そのコンピューターで暗号鍵を使用するには、rsa.pub ファイル名を維持し、そのファイルを抽出された SAClientUtil_<version>_<os>.zip ファイルの config ディレクトリーに置きます (<version> は コマンド行ユーティリティー の現在のバージョンです)。

注: 使用する暗号鍵は、最新のものである必要があります。IRX ファイルを古い暗号鍵で生成すると、アップロード時に IRX ファイルが拒否されます。ご使用のコンピューターがインターネットに接続されている場合は、prepare コマンドを再発行すると、暗号鍵が自動的に更新されます。ご使用のコンピューターがインターネットに接続されていない場合は、get_pubkey コマンドを使用する必要があります。

オプションのフラグ/設定:

  • -d: -d <save_path> と指定します。<save_path> には、暗号鍵の保存先ディレクトリーが入ります。このオプションが指定されていない場合、鍵は、抽出された SAClientUtil_<version>_<os>.zip ファイルの config ディレクトリーに保存されます。