ScanFolder

説明

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

構文

ounceauto ScanFolder
-folder_path <フォルダーのパス>
[-name <アセスメント名>]
[-scanconfig <スキャン構成名>]
[-waitforlicense <待機時間>]
[-save <ファイル名>]
[-caller <呼び出し元>]
[-publish]
[-clearcache]
[-report <レポート・タイプ> <出力形式> <出力場所>]
[-export <エクスポート・タイプ> <出力場所>]
[-classificationDefinitive]
[-classificationSuspect] 
[-classificationCoverage]
[-includeSrcBefore <n>]
[-includeSrcAfter <n>]
[-includeTraceDefinitive]
[-includeTraceSuspect]
[-includeTraceCoverage]
[-includeHowToFix]
[-enablesecrets <true/false>]
[-secretsonly <true/false>]
[-sourcecodeonly <true/false>]
[-severityHigh]
[-severityMedium] 
[-severityLow] 
[-severityInfo] 

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

• -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