Falhas do tipo CWE-1118

1 resultado

Documentação insuficiente de técnicas de tratamento de erros

Quando um componente de software não documenta adequadamente como seus erros são tratados, desenvolvedores que o utilizam não sabem quais exceções esperar, em que condições ocorrem ou como reagir. Isso leva a tratamento de erros incompleto ou incorreto no código dependente, deixando vulnerabilidades abertas.

Exemplo

Uma biblioteca retorna códigos de erro numéricos sem explicar o que cada número significa, ou lança exceções customizadas não documentadas. Quem integra a lib acaba ignorando erros porque não sabe se são críticos ou toleráveis, deixando falhas silenciosas em produção.

Como mitigar

Documente explicitamente todos os erros possíveis: código de retorno, exceção, mensagem, condição que o causa e ação recomendada. Use padrões como Javadoc, docstrings ou specs OpenAPI. Teste cenários de erro para validar que a documentação reflete a realidade do código.