設定コマンド (Windows™)

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

appscan prepare

構文:

appscan prepare -c <configuration_file> -d <save_path> -es, --enableSecrets -jdk <jdk_path> -l <log_path> -n <file_name>   -s <value> -sco,--sourceCodeOnly -so, --secretsOnly -t,--thirdParty -v,--verbose -X,--debug

説明:

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

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

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

  • -c: このオプションは、スキャンの構成に使用します。
  • -d: -d <save_path> と指定します。<save_path> には IRX ファイルを保存するディレクトリーが入ります。
  • -dr、--dryrun: -dr または --dryrun を指定してスキャン対象を見つけて検証しますが、.irx ファイルは生成しません。
  • -es, --enableSecrets: -es または --enableSecrets を指定して、シークレットのスキャンを有効にします。秘密のスキャンはデフォルトで無効になっています。
  • -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 ファイルの拡張子はつけてもつけなくても、ファイル名を指定できます。ファイル拡張子なしで指定すると、ファイル生成時に自動的に拡張子が付けられます。
  • -s: -s <value> と指定して、スキャンの速度と深さ指定します。<value> には simple、balanced、deep、または thorough が入ります。コマンド行で指定しスキャンの速度は、AppScan Go! で選択できるスキャンの速度に対応しています。
    • 単純スキャンでは、ファイルの表面レベルの分析を実行して、修復に最も急を要する問題を識別します。完了に要する時間が最も短いスキャンです。
    • バランス・スキャンでは、中程度の詳細レベルでセキュリティー問題の分析および特定を行うことができ、完了するのに「単純」スキャンよりはやや時間がかかります。
    • 詳細スキャンでは、ファイルの徹底的な分析を実行して脆弱性を特定します。通常、完了するのにより多くの時間がかかります。
    • 完全スキャンでは、包括的な分析を実行して、最も包括的な脆弱性リストを特定し、完了するのに最も多くの時間がかかります。
      注: スキャンの速度は、コードで検出された脆弱性の相対数と相関するとは限りません。例えば、単純スキャンで報告される可能性のある誤検出が完全分析では除外され、より少ない脆弱性が報告されることがあります。
    注: このオプションのパラメーターは大文字小文字を区別します。スキャンの速度が指定されていない場合、クライアント・ユーティリティーはデフォルトとして詳細スキャンを実行します。
  • -sao: 静的分析のみを実行する場合は -sao を指定します。
  • -sco, --sourceCodeOnly: -sco または --sourceCodeOnly と指定して、すべてのソース・コード・ファイルのみをスキャンします。この設定は、.dll、.exe、.jar、.war などの、サポートされる他のファイル・タイプのスキャンを無効にします。

    ソース・コードのみのスキャンは、ソース・コードへのアクセス権限のみを持っている場合、より高速なスキャンを実行したい場合、またはスキャンの深さよりも速度を優先したい場合に便利です。ビルド出力へのアクセス権限のみを持っている場合、またはスキャンの速度よりも深さを優先する場合は、代替スキャン・オプションを選択します。

    注: 組み込まれているソース・コードのみのファイル・タイプのリストについては、「静的分析の言語サポート 」を参照してください。
  • -so, --secretsOnly: -so または --secretsOnly を指定して、ソース・コードのシークレットのみをスキャンします。秘密のスキャンはデフォルトで無効になっています。
  • -t, --thirdParty: デフォルトで、サードパーティーの Java と .NET コードは IRX ファイルの生成中にスキャンされません。「サード・パーティーの Java と .NET の除外管理」の指示に従って、サードパーティーのコードの除外設定を変更できます。サードパーティーのコードを含めるには、prepare コマンドを発行するときに -t または --thirdParty オプションを指定します。

    サード・パーティー・コードがスキャンで標準的に除外されるようにする開発者の場合、この設定を使用してサード・パーティー・コードをスキャンに含める必要があります。

  • -v,--verbose: IRX ファイル生成中により多くの出力情報を表示するには、-v または --verbose を指定します。
  • -X,--debug: -X または --debug を指定すると、デバッグ・モードでコマンド全体が実行されます。デバッグ・モードで実行すると、トラブルシューティング用のログ・ファイルがより多く生成されます。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

この設定ファイル (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 package

構文:

appscan package -d <save_path> -f <assessment_file> -n <file_name>

説明:

IRX HCL バージョン 9.0 以降の製品で作成されたアセスメント (.ozasmt) ファイルを含む AppScan Source ファイルを生成します。

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

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

  • -d: -d <save_path> と指定します。<save_path> には IRX ファイルを保存するディレクトリーが入ります。
  • -n: -n <file_name> と指定します。<file_name> には、IRX ファイルの名前が入ります。.irx ファイルの拡張子はつけてもつけなくても、ファイル名を指定できます。ファイル拡張子なしで指定すると、ファイル生成時に自動的に拡張子が付けられます。
ヒント: すべてのコマンドで、オプションは任意の順序で使用できます。

例:

c:\my_irx_files ディレクトリー内で、次のコマンドを実行することで、アセスメント・ファイル c:\my_assessment_files\my_assessment.ozasmt を含む IRX ファイルを生成することができます。

appscan package -f c:\my_assessment_files\my_assessment.ozasmt

結果の IRX ファイルは c:\my_irx_files に保存されます。

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 ディレクトリーに保存されます。