Modello di documentazione del parser (Open Source)

Questo modello è pensato per documentare un parser nuovo o esistente. Sentiti libero di migliorarlo con qualsiasi informazione aggiuntiva che possa aiutare i tuoi colleghi professionisti della sicurezza.

• Copia questo file .md e aggiungilo a /docs/content/supported_tools/file nel repository GitHub.
• Aggiorna il titolo in modo che corrisponda al nome del tuo parser nuovo o esistente.
• Compila tutte le sezioni elencate di seguito. Rimuovi eventuali istruzioni o esempi presenti in ciascuna sezione.

Tipi di file#

Specifica tutti i tipi di file accettati dal tuo parser (ad es. CSV, JSON, XML). Includi le istruzioni su come creare o esportare il formato di file accettabile dallo strumento di sicurezza correlato.

Numero totale di campi in [Formato file]#

Campi dati totali: Numero totale di campi contenuti nel file di esportazione dello strumento di sicurezza. Campi dati totali analizzati: Numero totale di campi analizzati nel riscontro DefectDojo. Campi dati totali NON analizzati: Numero totale di campi NON analizzati nel riscontro DefectDojo.

Utilizzando il formato seguente, fornisci una breve descrizione di ciascun campo e di come viene mappato al modello dati di DefectDojo. Includi tutti i campi presenti nel file di esportazione dello strumento di sicurezza, in ordine di comparsa, indicando eventuali campi che non vengono analizzati.

Campi in ordine di comparsa:

1. Campo 1 - Descrizione di come viene mappato questo campo (ad es. viene mappato sul titolo del riscontro, sull’host dell’endpoint.)
2. Campo 2 - Descrizione di come viene mappato / non mappato questo campo.
3. Campo 3 - Descrizione di come viene mappato / non mappato questo campo.
4. Campo 4 - Descrizione di come viene mappato / non mappato questo campo. (continua per ogni campo nel file.)

Dettagli sulla mappatura dei campi#

Per ogni riscontro creato, includi i dettagli su come il parser analizza dati specifici. Ad esempio:

• Come vengono creati gli endpoint (ad es. combinando i campi IP, Dominio, Porta e Protocollo).
• Come vengono gestite le occorrenze (ad es. nb_occurences predefinito impostato a 1, incrementato per i duplicati).
• Come viene gestita la deduplicazione (ad es. utilizzando un hash di gravità + titolo + descrizione).
• Descrive la gravità predefinita se non viene trovata alcuna corrispondenza di mappatura.

Dati di scansione di esempio o Unit test#

Aggiungi un link alla cartella degli unit test o dei dati di scansione di esempio nel repository GitHub. Ad esempio:

• Cartella dei dati di scansione di esempio

Link allo strumento#

Fornisci un link allo scanner o allo strumento stesso (ad es. repository GitHub, sito web del vendor o documentazione). Ad esempio:

• Nome dello strumento