GenerateReport

Description

Créez un rapport à partir d'une évaluation.

Syntaxe

ounceauto GenerateReport
-assessment <assessment path>
-type <report type>
-output <output format>
-file <output location>
[-caller <caller>]
[-includeHowToFix]
[-includeSrcBefore <n>]
[-includeSrcAfter <n>]
[-includeTraceDefinitive]
[-includeTraceSuspect]
[-includeTraceCoverage]
  • -assessment <assessment path> : chemin d’accès au fichier d’évaluation pour lequel vous souhaitez générer le rapport.
  • -type "<report type>" : nom du type de rapport entre guillemets. Il peut s'agir de rapports sur les constatations, de rapports AppScan® Source et de rapports personnalisés.

    Les types de rapport AppScan® Source incluent :

    • Un rapport Constatations :
      • Findings
      • Findings by Fix Group
      • Findings by Type
      • Findings by Classification
      • Findings by File
      • Findings by API
      • Findings by Bundle
      • Findings by CWE
    • Rapport AppScan® Source :
      • 2024 CWE Top 25 Most Dangerous Software Weaknesses
      • 2021 CWE Top 25 Most Dangerous Software Weaknesses
      • DISA Application Security and Development STIG V5R3
      • DISA Application Security and Development STIG V6R3
      • OWASP API Security Top 10 2023
      • OWASP API Security Top 10 2019
      • OWASP Mobile Top 10
      • OWASP Top 10 2017
      • OWASP Top 10 2021
      • PCI Data Security Standard V4.0
      • Software Security Profile
    • Un rapport personnalisé, le cas échéant.

    Lorsque vous entrez le type de rapport entre guillemets, entrez-le exactement tel qu'il est spécifié dans la liste ci-dessus. Par exemple, Findings by Classification ou Software Security Profile.

  • -output <output format> : indiquez un des formats suivants pour ce rapport,
    • html : génère le rapport au format HTML et l'affiche en ligne.
    • zip : Crée un fichier ZIP qui contient tous les composants d'un rapport HTML
    • Pour les rapports au format PDF, vous pouvez spécifier le niveau de détails :
      • pdf-summary : contient les comptages pour chaque groupe de rapports personnalisé.
      • pdf-detailed : Contient les comptages pour chaque API de chaque propriété de vulnérabilité
      • pdf-comprehensive : Contient des tableaux composés de chaque constatation pour chaque API
      • pdf-annotated : contient toutes les constatations, toutes les remarques associées aux constatations, ainsi que les fragments de code désignés.
      • output location : Le chemin d'accès pour la rédaction du rapport.
  • -file <output location> : permet de spécifier le chemin et le nom de fichier pour enregistrer le rapport.
  • -caller <caller> : Facultatif. Permet d'affecter un appelant à l'opération de génération de rapport. 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.
  • -includeHowToFix : Facultatif. Joignez des recommandations sur la façon de traiter et de corriger les constatations.
  • -includeSrcBefore <n> : Facultatif. Le nombre de lignes de code source à inclure avant chaque constatation.
  • -includeSrcAfter <n> : Facultatif. Le nombre de lignes de code source à inclure après chaque constatation.
  • -includeTraceDefinitive : Facultatif. 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 : Facultatif. Permet d'inclure des informations de trace des constatations suspectes dans le rapport.
  • -includeTraceCoverage : Facultatif. Permet d'inclure des informations de trace des constatations de couverture de l'examen dans le rapport.

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

  • Générez un rapport Constatations par API au format HTML. Dans le rapport, incluez les informations de trace pour les constatations définitives :
    ounceauto generatereport -assessment C:\Ounce\Data\Webgoat.ozasmt
-type "Findings by API" -output html
-file C:\reports\Webgoat_Findings.html
-includeTraceDefinitive
  • Pour générer un rapport OWASP Top 10 2013 AppScan® Source au format PDF, entrez la commande suivante :
    ounceauto generatereport -assessment C:\Ounce\Data\Webgoat.ozasmt
-type "OWASP Top 10 2013" -output pdf-annotated
-file C:\Reports\Webgoat_OWASP.pdf