Skip to content

Anti-padrões de segurança em APIs ​

Checklist preventivo aplicado às APIs do monorepo. Cada item é uma armadilha clássica de segurança em REST com a forma de mitigação adotada por padrão na Fábrica.

1. Não colocar segredos em URL sem mascarar logs ​

  • Tokens em path vazam facilmente para logs de aplicação, proxies, APM e histórico.
  • Se a URL precisar carregar um token de uso único, o log operacional deve registrar apenas a rota sanitizada.

2. Não expor DTO interno como resposta pública ​

  • DTO persistido costuma conter campos administrativos ou dados pessoais que não pertencem à interface pública.
  • Links públicos devem projetar explicitamente o payload retornável.

3. Não usar fallback implícito para claims sensíveis de JWT ​

  • Claims como CPF precisam de um nome canônico único.
  • sub ?? cpf ou padrões equivalentes geram ambiguidade e risco de associar dados ao identificador errado.

4. Não transformar falha de autenticação em anonimato silencioso ​

  • Fluxo anônimo só é aceitável quando a requisição realmente não trouxe credencial.
  • Se Authorization foi enviado e a validação falhou, a resposta deve ser erro e o evento deve ser tratado como falha de autenticação.

5. Não revelar existência de recurso multi-tenant ​

  • Quando o recurso pertence a um usuário específico, a consulta deve combinar identificador do recurso e identificador do dono.
  • O retorno deve ser 404 tanto para "não existe" quanto para "existe, mas é de outro usuário".

6. Contrato de erro deve refletir o comportamento real ​

  • Nas apps que estendem a camada de API, toda resposta — sucesso ou erro — sai no envelope PDPJ-Br {status, code, messages, result}. O que as rotas lançam passa pelo tratador de erros da camada; o que escapa delas (404 do roteador, recusas de autenticação e de chave de API, indisponibilidade) é capturado por um tratador global, que negocia por conteúdo: Accept: text/html recebe uma página, qualquer outro cliente recebe o envelope.
  • Divergência conhecida e deliberada: verbo HTTP errado responde 404, não 405 com Allow — só o servidor MCP responde 405.
  • README, OpenAPI e testes descrevem a forma real do erro, inclusive esse 404; nunca um envelope imaginado. Mensagens 5xx ficam genéricas — o detalhe vai para o log, não para a resposta.