設定コマンド (Windows)

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

appscan prepare

構文:

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

説明:

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

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

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

  • -c: このオプションは、スキャンの構成に使用します。
  • -d: -d <save_path> と指定します。<save_path> には IRX ファイルを保存するディレクトリーが入ります。
  • -dr、--dryrun: -dr または --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 ファイルの拡張子はつけてもつけなくても、ファイル名を指定できます。ファイル拡張子なしで指定すると、ファイル生成時に自動的に拡張子が付けられます。
  • -nc、--noConfigFiles: ソフトウェア・コンポジション分析 (SCA) の設定ファイルの処理を無効にします。
  • -oso: SCA パッケージで既知の脆弱性のみを探すには、-oso を指定します。-oso を指定した場合、AppScan on Cloud はパッケージでの静的分析を実行しません
    注: ユーザーがオープン・ソース・ライセンスを持っている場合、SCA 分析はデフォルトで静的スキャンに含まれます。このオプションでは、分析が SCA の脆弱性に限定されます。SCA のみの分析を利用するには、オープン・ソース・ライセンスを持っている必要があります。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

この設定ファイル (c:\my_config_files\my_config.xml) を使用する IRX ファイルを生成し、IRX ファイルをc:my__filesmy_scan に保存するには、以下のコマンドを実行します。

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 ファイルを生成します。パラメーターを指定せずに実行する場合、このコマンドは appscanprepare -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 (<version>コマンド行ユーティリティー の現行バージョン) ファイルの config ディレクトリーに置く必要があります。

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

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

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