scan (sc)

説明

アプリケーション (またはすべてのアプリケーション)、プロジェクト、フォルダー (またはすべてのフォルダー)、またはファイルをスキャンします。このコマンドを使用するには、有効な AppScan® Source for Automation のライセンスが必要です。

重要: 開発環境内に依存関係を持つ AppScan® Source プロジェクト (例えば、IBM® MobileFirst Platform プロジェクト) を処理する場合は、必ずプロジェクトをインポートする前に開発環境でビルドしてください。プロジェクトをインポートした後、その中のファイルを変更した場合は、AppScan® Source でスキャンする前に開発環境で再ビルドしてください (そうしないと、ファイルに対する変更は AppScan® Source によって無視されます)。
注: フォルダーをスキャンする場合、デフォルトでは、言語に関係なくターゲット・フォルダー内のすべてのファイルがスキャンされます。そのため、スキャン結果は、アプリケーションまたはプロジェクトのスキャンとは異なる場合があります。特定のファイルをターゲットにするには、appscan-config.xml ファイルを作成してスキャン・ターゲットを定義します。appscan-config.xml ファイルがターゲット・フォルダーに存在する場合は、その中の構成情報がスキャン・プロセスによって自動的に考慮されます。

構文

scan [path][config <proj_config>][-name <assessment_name>][-scanconfig <scan_configuration_name>] [-sourcecodeonly <true/false>] [-enablesecrets <true/false>] [-secretsonly <true/false>] [-waitforlicense <wait_time>]
  • path: オプション。エクスポートされた評価を保存する絶対パスとファイル名 (.ozasmt)。
    注:
    • ファイル名を付けずに有効なディレクトリーを指定すると、評価ファイル (.ozasmt) は、評価の作成時に使用されたアプリケーション名、プロジェクト名、およびスキャン構成に基づいて作成されます。
    • 存在しないファイル名を使用して有効なディレクトリーを指定すると、指定したファイル名を使用してその場所に評価ファイルが作成されます。
    • 既に存在するファイルを指定した場合、既存のファイルが上書きされます。
    • 存在しないディレクトリーにファイル名 (.ozasmt) を指定すると、評価は保存されません。
  • config <proj_config>: オプション。この引数は、プロジェクト・レベルの評価にのみ有効です。プロジェクトに構成ファイルがある場合、この引数を使用して構成ファイルを指定します。
  • -name <assessment_name>: オプション。評価の名前を指定します。AppScan® Source クライアント製品は、この名前を使用して互いの評価を区別します (例えば、AppScan® Source for Analysis では、この名前が「自分の評価」ビューの「名前」列に表示されます)。
  • -enablesecrets <true/false>: オプション。シークレット・スキャナーだけでなく他の関連スキャナーを使用してソース・ファイルをスキャンするように指定します。有効な値は true および false です。
    注: -enablesecrets-secretsonly は相互に排他的ですこれらの値を同時に true にすることはできません。
    注: scan.ozsettings の enable_secrets_scanner 設定を使用して、グローバルにシークレット・スキャンを有効にできます。
  • -scanconfig <scan_configuration_name>: オプション。スキャンに使用するスキャン構成の名前を指定します。スキャン構成を指定していない場合、デフォルトのスキャン構成がスキャンに使用されます。
  • -secretsonly <true/false>: オプション。シークレット・スキャナーのみでソース・ファイルをスキャンするように指定します。有効な値は truefalse です。
    注: -enablesecrets-secretsonly は相互に排他的ですこれらの値を同時に true にすることはできません。
  • -sourcecodeonly <true/false>: オプション。ソース・ファイルのみをスキャンし、サポートされている他のファイル・タイプ (.dll.exe) は無視することを指定します。有効な値は truefalse です。
  • -waitforlicense <wait_time>: オプション。AppScan® Source for Automation ライセンスがないときに、スキャンが待機する時間を分単位で指定します。-waitforlicense を使用して待機時間が示されていない場合、デフォルト値が CLI.ozsettings から取得されます。待機時間を無効にするには、値を 0 に設定します。
注: -enablesecrets-secretsonly、および -sourcecodeonly オプションは、フォルダー・スキャンの場合のみサポートされます。これは、アプリケーション・スキャンおよびプロジェクト・スキャンには適用されません。

例(X)

  • すべてのアプリケーションでプロジェクトのデフォルト構成をスキャンするには、以下のように指定します。
    AllApplications>> Scan

    結果が以下のように表示されます。

    New Scan started
    		.
    		.
    Preparing for Vulnerability Analysis...
    Performing Vulnerability Analysis...
    Generating Findings...
    Preparing project for scan...
    		.
    		.
    Scanned Project:
      Total files: 15
      Total findings: 167
      Total lines: 385
    	vkloc: 0.44448395412925595
    	v-Density: 22.446439683527426
    Scanned Application:
      Total files: 15
      Total findings: 167
      Total lines: 385
    	vkloc: 0.44448395412925595
    	v-Density: 22.446439683527426
    Scan completed:
      Total files: 15
      Total findings: 167
      Total lines: 385
    	vkloc: 0.44448395412925595
    	v-Density: 22.446439683527426
    Elapsed Time - 18 Seconds
    New Scan started. Please wait...
    Assessment complete
    -------------------
    Total Call Sites: 75
    Total Definitive Security Findings with High Severity: 25
    Total Definitive Security Findings with Medium Severity: 37
    Total Definitive Security Findings with Low Severity: 9
    Total Suspect Security Findings with High Severity: 20
    Total Suspect Security Findings with Medium Severity: 80
    Total Suspect Security Findings with Low Severity: 60
    Total Scan Coverage Findings with High Severity: 50
    Total Scan Coverage Findings with Medium Severity: 33
    Total Scan Coverage Findings with Low Severity: 17
    Total Lines: 3000
    ...
  • Prj1のデバッグ構成をスキャンするには、以下のように指定します。
    AllApplications\Prj1>> SC config debug
  • フォルダーをスキャンするには、以下のように指定します。
    AllApplications>> of C:\workspace\SimpleIOT
    SimpleIOT>> Scan