ScanFolder

Description

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

Syntaxe

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> : Requis. Chemin d'un dossier existant à examiner.
  • -name <assessment name> : Facultatif. Un nom pour l'évaluation.
  • -scanconfig <scan_configuration_name> : 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 <wait_time> : Facultatif. Spécifiez le temps d'attente en minutes pendant lequel un examen attend lorsqu'une licence AppScan® Source for Automation n'est pas 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 <filename> : Facultatif. Enregistrer les résultats de l'évaluation dans ce fichier.
  • -caller <caller> : Facultatif. Permet d'affecter un appelant à l'opération. Il peut s'agir du nom d'un utilisateur réel, mais cela n'est pas une obligation. Le nom de l'appelant est consigné au fichier journal ounceauto.
  • -publish : Facultatif. Publier l'évaluation après l'examen.
  • -clearcache : Facultatif. Cette commande supprime 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. Il peut s'agir de rapports sur les constatations, de rapports AppScan® Source et de rapports personnalisés. Voir les options dans GenerateReport.
      • <output format> : Définir le format du rapport. Voir les options dans GenerateReport.
      • <output location> : L'emplacement où enregistrer le rapport.
    • Facultatif -options de la commande de rapport :
      • -includeSrcBefore <n> : Le nombre de lignes de code source à inclure avant chaque constatation.
      • -includeSrcAfter <n> : Le nombre de lignes de code source à inclure après chaque constatation.
      • -includeTraceDefinitive : Incluez les informations de trace dans le rapport pour les constatations définitives (voir Classifications pour plus de détails sur les classifications des constatations).
      • -includeTraceSuspect : Permet d'inclure des informations de trace des constatations suspectes dans le rapport.
      • -includeTraceCoverage : Permet d'inclure des informations de trace des constatations de couverture de l'examen.
  • -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 d'accès 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 pour l'examen de fichiers source avec un scanner de codes secrets en plus des autres scanners pertinents. Les valeurs valables sont vraies et fausses.
  • -secretsonly <true/false> : Facultatif. Spécifiez pour l'examen de fichiers source uniquement avec le scanner de codes secrets. Les valeurs valables sont vraies et fausses.
  • -sourcecodeonly <true/false> : Facultatif. Spécifiez pour n'examiner que les fichiers source et ignorer les autres types de fichiers pris en charge (.dll, .exe). Les valeurs valables sont vraies et fausses

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