Modèle de documentation de parser (Open Source)

Ce modèle est conçu pour documenter un parser nouveau ou existant. N’hésitez pas à l’améliorer avec toute information supplémentaire susceptible d’aider vos collègues professionnels de la sécurité.

• Copiez ce fichier .md et ajoutez-le dans /docs/content/supported_tools/file du dépôt GitHub.
• Mettez à jour le titre pour qu’il corresponde au nom de votre parser nouveau ou existant.
• Remplissez toutes les sections listées ci-dessous. Merci de supprimer les instructions ou exemples présents dans chaque section.

Types de fichiers#

Précisez tous les types de fichiers acceptés par votre parser (par ex., CSV, JSON, XML). Incluez les instructions pour créer ou exporter le format de fichier accepté depuis l’outil de sécurité concerné.

Total des champs dans [File Format]#

Nombre total de champs : Nombre total de champs contenus dans le fichier d’export de l’outil de sécurité. Nombre total de champs parsés : Nombre total de champs parsés dans le finding DefectDojo. Nombre total de champs NON parsés : Nombre total de champs NON parsés dans le finding DefectDojo.

En utilisant le format ci-dessous, fournissez une brève description de chaque champ et de la façon dont il correspond au modèle de données de DefectDojo. Incluez tous les champs trouvés dans le fichier d’export de l’outil de sécurité, dans leur ordre d’apparition, en indiquant les champs qui ne sont pas parsés.

Champs dans l’ordre d’apparition :

1. Champ 1 - Description de la façon dont ce champ est mappé (par ex., mappé vers le titre du finding, l’hôte de l’endpoint.)
2. Champ 2 - Description de la façon dont ce champ est mappé / non mappé.
3. Champ 3 - Description de la façon dont ce champ est mappé / non mappé.
4. Champ 4 - Description de la façon dont ce champ est mappé / non mappé. (continuez pour chaque champ du fichier.)

Détails du mappage des champs#

Pour chaque finding créé, incluez des détails sur la façon dont le parser analyse les données spécifiques. Par exemple :

• Comment les endpoints sont créés (par ex., en combinant les champs IP, Domain, Port et Protocol).
• Comment les occurrences sont gérées (par ex., nb_occurences par défaut fixé à 1, incrémenté pour les doublons).
• Comment la déduplication est gérée (par ex., à l’aide d’un hash de severity + title + description).
• Décrit la sévérité par défaut si aucun mappage ne correspond.

Données de scan d’exemple ou tests unitaires#

Ajoutez un lien vers le dossier des tests unitaires ou des données de scan d’exemple dans le dépôt GitHub. Par exemple :

• Dossier de données de scan d’exemple

Lien vers l’outil#

Fournissez un lien vers le scanner ou l’outil lui-même (par ex., dépôt GitHub, site de l’éditeur ou documentation). Par exemple :

• Nom de l’outil