Weaknesses of type CWE-1059
3 resultsDocumentação técnica insuficiente
Quando um software, componente ou API não possui documentação técnica adequada sobre seu funcionamento, limitações de segurança ou comportamentos esperados, desenvolvedores e administradores ficam vulneráveis a configurações erradas, uso inadequado ou a interpretações incorretas de como o código se comporta. Isso abre espaço para brechas de segurança não intencionais.
Uma biblioteca de criptografia que não documenta explicitamente qual é o tamanho mínimo de chave seguro ou não explica os riscos de usar certos modos de operação desaconselhados — leva desenvolvedores a implementar com parâmetros fracos por desconhecimento.
Mantenha documentação técnica clara e atualizada sobre limites de segurança, comportamentos críticos, configurações recomendadas e cenários de risco. Inclua exemplos de uso correto e explicitamente o que NÃO fazer. Revise a documentação sempre que houver mudanças no código.