Vorlage für Parser-Dokumentation (Open Source)

Diese Vorlage dient dazu, einen neuen oder bestehenden Parser zu dokumentieren. Ergänzen Sie sie gerne um weitere Informationen, die anderen Sicherheitsfachleuten helfen können.

• Kopieren Sie diese .md-Datei und fügen Sie sie im GitHub-Repository unter /docs/content/supported_tools/file ein.
• Passen Sie den Titel an den Namen Ihres neuen oder bestehenden Parsers an.
• Füllen Sie alle unten aufgeführten Abschnitte aus. Entfernen Sie bitte alle Hinweise und Beispiele, die in den einzelnen Abschnitten enthalten sind.

Dateitypen#

Geben Sie alle Dateitypen an, die Ihr Parser akzeptiert (z. B. CSV, JSON, XML). Beschreiben Sie, wie das akzeptierte Dateiformat mit dem zugehörigen Sicherheitswerkzeug erzeugt oder exportiert wird.

Gesamtzahl der Felder in [Dateiformat]#

Datenfelder insgesamt: Gesamtzahl der Felder in der Exportdatei des Sicherheitswerkzeugs. Geparste Datenfelder insgesamt: Gesamtzahl der Felder, die in den DefectDojo-Befund geparst werden. NICHT geparste Datenfelder insgesamt: Gesamtzahl der Felder, die NICHT in den DefectDojo-Befund geparst werden.

Beschreiben Sie im folgenden Format kurz jedes Feld und wie es auf das Datenmodell von DefectDojo abgebildet wird. Führen Sie alle Felder aus der Exportdatei des Sicherheitswerkzeugs in der Reihenfolge ihres Auftretens auf und kennzeichnen Sie Felder, die nicht geparst werden.

Felder in der Reihenfolge ihres Auftretens:

1. Feld 1 - Beschreibung, wie dieses Feld abgebildet wird (z. B. auf den Titel des Befunds oder den Host des Endpunkts.)
2. Feld 2 - Beschreibung, wie dieses Feld abgebildet bzw. nicht abgebildet wird.
3. Feld 3 - Beschreibung, wie dieses Feld abgebildet bzw. nicht abgebildet wird.
4. Feld 4 - Beschreibung, wie dieses Feld abgebildet bzw. nicht abgebildet wird. (für jedes Feld in der Datei fortsetzen.)

Details zur Feldzuordnung#

Beschreiben Sie für jeden erzeugten Befund, wie der Parser bestimmte Daten verarbeitet. Zum Beispiel:

• Wie Endpunkte erzeugt werden (z. B. durch Kombination der Felder IP, Domain, Port und Protokoll).
• Wie Vorkommen behandelt werden (z. B. nb_occurences standardmäßig auf 1 gesetzt, bei Duplikaten erhöht).
• Wie die Deduplizierung erfolgt (z. B. über einen Hash aus Schweregrad + Titel + Beschreibung).
• Beschreibt den Standard-Schweregrad, wenn keine Zuordnung zutrifft.

Beispiel-Scandaten oder Unit-Tests#

Fügen Sie einen Link zum Ordner mit den Unit-Tests oder den Beispiel-Scandaten im GitHub-Repository hinzu. Zum Beispiel:

• Ordner mit Beispiel-Scandaten

Link zum Tool#

Geben Sie einen Link zum Scanner oder Tool selbst an (z. B. GitHub-Repository, Anbieter-Website oder Dokumentation). Zum Beispiel:

• Tool-Name