Template de Documentação de Parser (Open Source)

Este template foi criado para documentar um parser novo ou existente. Sinta-se à vontade para melhorá-lo com qualquer informação adicional que possa ajudar seus colegas profissionais de segurança.

• Copie este arquivo .md e adicione-o em /docs/content/supported_tools/file no repositório do GitHub.
• Atualize o título para corresponder ao nome do seu parser novo ou existente.
• Preencha todas as seções listadas abaixo. Remova quaisquer instruções ou exemplos encontrados em cada seção.

File Types#

Especifique todos os tipos de arquivo aceitos pelo seu parser (por exemplo, CSV, JSON, XML). Inclua instruções sobre como criar ou exportar o formato de arquivo aceitável a partir da ferramenta de segurança relacionada.

Total Fields in [File Format]#

Total data fields: Número total de campos contidos no arquivo de exportação da ferramenta de segurança. Total data fields parsed: Número total de campos parseados para o finding do DefectDojo. Total data fields NOT parsed: Número total de campos NÃO parseados para o finding do DefectDojo.

Usando o formato abaixo, forneça uma breve descrição de cada campo e como ele é mapeado para o modelo de dados do DefectDojo. Inclua todos os campos encontrados no arquivo de exportação da ferramenta de segurança, na ordem em que aparecem, indicando quaisquer campos que não sejam parseados.

Fields in order of appearance:

1. Field 1 - Descrição de como esse campo é mapeado (por exemplo, mapeia para o título do finding, host do endpoint.)
2. Field 2 - Descrição de como esse campo é mapeado / não mapeado.
3. Field 3 - Descrição de como esse campo é mapeado / não mapeado.
4. Field 4 - Descrição de como esse campo é mapeado / não mapeado. (continue para cada campo do arquivo.)

Field Mapping Details#

Para cada finding criado, inclua detalhes de como o parser processa dados específicos. Por exemplo:

• Como os endpoints são criados (por exemplo, combinando os campos IP, Domain, Port e Protocol).
• Como as ocorrências são tratadas (por exemplo, nb_occurences padrão definido como 1, incrementado para duplicatas).
• Como a deduplicação é tratada (por exemplo, usando um hash de severity + title + description).
• Descreve a severidade padrão caso nenhum mapeamento seja correspondido.

Sample Scan Data or Unit Tests#

Adicione um link para a pasta de testes unitários ou de dados de scan de exemplo no repositório do GitHub. Por exemplo:

• Sample Scan Data Folder

Link To Tool#

Forneça um link para o próprio scanner ou ferramenta (por exemplo, repositório do GitHub, site do fornecedor ou documentação). Por exemplo:

• Tool Name