Escrever relatórios de vulnerabilidades

Utilize $codex-security:vulnerability-writeup para criar um relatório autónomo para cada vulnerabilidade distinta. Pode partir dos resultados de uma análise do Codex Security ou utilizar diretamente as descobertas, notas de divulgação, PoCs e código-fonte fornecidos. Não é necessária uma análise do Codex Security.

Preparar as evidências

Forneça ao fluxo de trabalho:

• As constatações, notas de divulgação ou documentos de avaliação a rever.
• A árvore de código-fonte de destino e a revisão ou versão afetada.
• PoCs, registos, rastos, capturas de ecrã ou resultados de diagnóstico existentes.
• Commits de correção ou diffs, quando disponíveis.

O Codex verifica cada afirmação face ao código-fonte afetado antes de escrever o relatório. Se o código-fonte ou a revisão afetada não estiver disponível, decida se pretende prosseguir com um relatório que identifique as afirmações não verificadas.

Executar o fluxo de trabalho

Envie um pedido como:

Use $codex-security:vulnerability-writeup to create one self-contained report for each distinct vulnerability in [input paths]. Verify the claims against [source path and revision], preserve or improve the supplied PoCs, and write the reports to [output directory]. Use a local test environment for reproductions.

O Codex inventaria o material fornecido, agrupa os relatórios que descrevem a mesma causa raiz e o mesmo percurso vulnerável e cria um diretório de relatório por cada vulnerabilidade distinta. Cada diretório contém um relatório Markdown e um diretório poc/ quando existem ficheiros de apoio à PoC.

Rever cada relatório

Antes de distribuir um relatório, confirme que este:

• Segue o erro desde o ponto de entrada controlado pelo atacante até à violação do invariante de segurança e ao impacto.
• Distingue o comportamento verificado das hipóteses e das restrições por resolver.
• Inclui excertos do código-fonte com caminhos, funções e a revisão afetada.
• Inclui o código-fonte da PoC, instruções de compilação ou execução, resultados representativos e limitações de segurança quando uma PoC é viável.
• Utiliza caminhos portáveis e não depende de armazenamento interno nem de caminhos absolutos locais.

Utilizar relatórios de uma análise

Os relatórios detalhados de vulnerabilidades são opcionais em análises padrão, aprofundadas e de alterações. Quando os solicita, o Codex escreve cada relatório em findings/<slug>/<slug>.md, armazena os ficheiros de suporte em findings/<slug>/poc/ e cria uma ligação para o relatório a partir de report.md.

Mantenha o diretório completo da análise ao partilhar ou arquivar uma análise. Para procurar melhorias que abordem padrões comuns aos vários relatórios, prossiga para Propor o reforço da segurança.