ScanFolder

Description

Examinez le dossier spécifié et effectuez d'autres actions liées à l'examen.

Syntaxe

ounceauto ScanFolder
-folder_path <chemin du dossier>
[-name <nom de l'évaluation>]
[-scanconfig <scan_configuration_name>]
[-waitforlicense <wait_time>]
[-save <filename>]
[-caller <caller>]
[-publish]
[-clearcache]
[-report <type de rapport> <format de sortie> <emplacement de sortie>]
[-export <type d'exportation> <emplacement de sortie>]
[-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 <chemin du dossier> : Obligatoire. Chemin d'un dossier existant à examiner.
  • -name <nom de l'évaluation> : Facultatif. Un nom pour l'évaluation.
  • -scanconfig <analyse_configuration_nom> : Facultatif. Spécifiez le nom d'une configuration d'examen à utiliser pour l'examen. Si aucune configuration d'examen n'est indiquée, la configuration d'examen par défaut va être utilisée pour l'examen.
  • -waitforlicense <temps_attente> : Facultatif. Spécifiez le temps d'attente en minutes pendant lequel une analyse patientera lorsqu'aucune licence AppScan® Source for Automation n'est disponible. Si aucun temps d'attente n'est indiqué à l'aide de -waitforlicense, une valeur par défaut est obtenue à partir de CLI.ozsettings. Le temps d'attente peut être désactivé en réglant la valeur sur 0.
  • -save <nom_fichier> : Facultatif. Enregistrer les résultats de l'évaluation dans ce fichier.
  • -caller <caller> : Facultatif. Affecter un appelant à l'opération. Il peut s'agir du nom d'un utilisateur réel, sans que cela soit obligatoire. Le nom de l'appelant est consigné dans le fichier journal ounceauto.
  • -publish : Facultatif. Publier l'évaluation après l'examen.
  • -clearcache : Facultatif. Supprimer le cache d'analyse de vulnérabilité et les données de signature des règles personnalisées avant l'examen.
  • -report : Facultatif. Générer un rapport après l'examen.
    • Options obligatoires de la commande -report :
      • <report type> : Type de rapport. Les types de rapport comprennent les rapports sur les constatations, les rapports AppScan® Source et les rapports personnalisés. Voir les options dans GenerateReport.
      • <output format> : Spécifiez le format du rapport. Voir les options dans GenerateReport.
      • <output location> : Emplacement d'enregistrement du rapport.
    • Options facultatives de la commande -report :
      • -classificationDefinitive : Filtrer les résultats définitifs.
      • -classificationSuspect : Filtrer les résultats suspects.
      • -classificationCoverage : Filtrer les résultats de couverture d'analyse.
      • -includeSrcBefore <n> : Nombre de lignes de code source à inclure avant chaque résultat.
      • -includeSrcAfter <n> : Nombre de lignes de code source à inclure après chaque résultat.
      • -includeTraceDefinitive : Inclure les informations de trace dans le rapport pour les résultats définitifs (voir Classifications pour en savoir plus sur les classifications des résultats).
      • -includeTraceSuspect : Inclure les informations de trace dans le rapport pour les résultats suspects.
      • -includeTraceCoverage : Inclure les informations de trace dans le rapport pour les résultats de couverture d'analyse.
      • -severityHigh : Filtrer les résultats de gravité élevée.
      • -severityMedium : Filtrer les résultats de gravité moyenne.
      • -severityLow : Filtrer les résultats de gravité faible.
      • -severityInfo : Filtrer les résultats de gravité informationnelle.
  • -export : Facultatif. Exportez les constatations d'examen dans un fichier CSV ou SARIF. Si cette commande est utilisée, les options de commande suivantes sont requises.
    • <export type> : Format du rapport exporté, CSV ou SARIF.
    • <output location> : Chemin et nom du fichier dans lequel enregistrer le rapport.
  • -includeHowToFix : Facultatif. Joignez des recommandations sur la façon de traiter et de corriger les constatations.
  • -enablesecrets <true/false> : Facultatif. Spécifiez d’analyser les fichiers source avec le scanner de secrets, en plus des autres scanners pertinents. Les valeurs valides sont true et false.
  • -secretsonly <true/false> : Facultatif. Spécifiez d’analyser les fichiers source uniquement avec le scanner de secrets. Les valeurs valides sont true et false.
  • -sourcecodeonly <true/false> : Facultatif. Spécifier pour n'examiner que les fichiers source et ignorer les autres types de fichiers pris en charge (.dll, .exe). Les valeurs valides sont true et false

Remarque : -enablesecrets et -secretsonly sont mutuellement exclusifs. Elles ne peuvent pas être vraies simultanément.

Valeur de retour

L'ID de la demande en cas de réussite, ou -1 si la soumission de la demande n'a pas abouti.

Exemples

  • Analyser le dossier WebGoat :
    ounceauto scanfolder -folder_path "C:\WebGoat"
  • Examinez le dossier WebGoat et créez un rapport Constatations dans le répertoire C:\WebGoat. Dans le rapport, incluez les informations de trace pour les constatations définitives :
    ounceauto scanfolder -folder_path "C:\WebGoat" -report Findings html "C:\WebGoat\MyReport.html" -includeTraceDefinitive