ScanFolder

説明

指定されたフォルダーをスキャンし、スキャンに関連するその他のアクションを実行します。

構文

ounceauto ScanFolder
-folder_path <path to folder>
[-name <assessment name>]
[-scanconfig <scan_configuration_name>]
[-waitforlicense <wait_time>]
[-save <filename>]
[-caller <caller>]
[-publish]
[-clearcache]
[-report <report type> <output format> <output location>]
[-export <export type> <output location>]
[-includeSrcBefore <n>]
[-includeSrcAfter <n>]
[-includeTraceDefinitive]
[-includeTraceSuspect]
[-includeTraceCoverage]
[-includeHowToFix]
[-enablesecrets <true/false>]
[-secretsonly <true/false>]
[-sourcecodeonly <true/false>]

• -folder_path <path to folder>: 必須。スキャンする既存のフォルダーのパス。
• -name <assessment name>: オプション。評価の名前。
• -scanconfig <scan_configuration_name>: オプション。スキャンに使用するスキャン構成の名前を指定します。スキャン構成を指定していない場合、デフォルトのスキャン構成がスキャンに使用されます。
• -waitforlicense <wait_time>: オプション。AppScan® Source for Automation ライセンスがないときに、スキャンが待機する時間を分単位で指定します。-waitforlicense を使用して待機時間が示されていない場合、デフォルト値が CLI.ozsettings から取得されます。待機時間を無効にするには、値を 0 に設定します。
• -save <filename>: オプション。評価結果をこのファイルに保存します。
• -caller <caller>: オプション。呼び出し元を操作に割り当てます。呼び出し元は実際のユーザーの名前で構いませんが、これは必須ではありません。呼び出し元の名前は、ounceauto ログ・ファイルに書き込まれます。
• -publish: オプション。スキャン後に評価を公開します。
• -clearcache: オプション。スキャンの前に脆弱性分析キャッシュおよびカスタム・ルールのシグニチャー・データを削除します。
• -report: オプション。スキャン後にレポートを生成します。
  • 必須の -report コマンド・オプション:
    • <report type>: レポートのタイプ。レポート・タイプは、検出結果レポート、AppScan® Source レポート、およびカスタム・レポートで構成されます。GenerateReport のオプションを参照してください。
    • <output format>: レポートの形式を指定します。GenerateReport のオプションを参照してください。
    • <output location>: レポートを保存する場所。
  • オプションの -report コマンド・オプション:
    • -includeSrcBefore <n>: 各検出結果の前に組み込むソース・コードの行数。
    • -includeSrcAfter <n>: 各検出結果の後に組み込むソース・コードの行数。
    • -includeTraceDefinitive: 確定の検出結果のレポートにトレース情報を含めます (検出結果の分類については、「分類」を参照してください)。
    • -includeTraceSuspect: 要確認の検出結果のレポートにトレース情報を含めます。
    • -includeTraceCoverage: スキャン範囲の検出結果のレポートにトレース情報を含めます。

• -export: オプション。スキャン検出結果を CSV または SARIF ファイルにエクスポートします。使用する場合は、以下のコマンド・オプションが必要です。
  • <export type>: エクスポートされるレポートの形式 (CSV または SARIF)。
  • <output location>: レポートの保存先のパスおよびファイル名。

• -includeHowToFix: オプション。結果の対処方法と修正方法に関するアドバイザリー情報を含めます。
• -enablesecrets <true/false>: オプション。シークレット・スキャナーだけでなく他の関連スキャナーを使用してソース・ファイルをスキャンするように指定します。有効な値は true と false です。
• -secretsonly <true/false>: オプション。シークレット・スキャナーのみでソース・ファイルをスキャンするように指定します。有効な値は true と false です。
• -sourcecodeonly <true/false>: オプション。ソース・ファイルのみをスキャンし、サポートされている他のファイル・タイプ (.dll、.exe) は無視することを指定します。有効な値は true と false です

注: -enablesecrets と -secretsonly は相互に排他的です。これらの値を同時に true にすることはできません。

戻り値

要求の実行依頼が正常に実行された場合は要求 ID、正常に実行されなかった場合は -1。

例

• WebGoat フォルダーをスキャンします。

  ounceauto scanfolder -folder_path "C:\WebGoat"

• WebGoat フォルダーをスキャンして、C:\WebGoat ディレクトリーに検出結果レポートを作成します。レポートで、確定の検出結果にトレース情報を含めるには以下のようにします。

  ounceauto scanfolder -folder_path "C:\WebGoat" -report Findings html "C:\WebGoat\MyReport.html" -includeTraceDefinitive