Skip to content

fix: alert-relay não loga o token do bot (httpx/httpcore em WARNING + filtro de redação) - #215

Merged
nitaibezerra merged 4 commits into
mainfrom
fix/alert-relay-token-no-log
Nov 3, 2026
Merged

nitaibezerra merged 4 commits into
mainfrom
fix/alert-relay-token-no-log

Conversation

@nitaibezerra

@nitaibezerra nitaibezerra commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Problema

No teste ponta a ponta do alert-relay (#214), em 03/11 às 13:25:35Z, o logger da biblioteca httpx gravou uma linha HTTP Request: POST https://api.telegram.org/bot<TOKEN>/sendMessage no stdout do serviço, revisão 00002-f9n.

  • Causa: a URL da Bot API contém o token, e o logging.basicConfig(level=INFO) do app deixa o httpx logar requisições em INFO.
  • Por que o teste não pegou: o teste "token fora do log" do feature: alert-relay — alertas de dgb.ops.alerts no Telegram da equipe #214 mockava o httpx.post, então o logger da biblioteca nunca rodou.
  • Exposição: 1 entrada no Cloud Logging do projeto.
  • O token deve ser considerado comprometido. Rotação no BotFather e versão nova do secret ops-alerts-telegram-bot-token ficam com o usuário.

Correção

  • telegram.py:
    • Os loggers httpx, httpcore e urllib3 (este usado pelo google-auth) ficam em WARNING desde o import.
    • sanitize() troca /bot<...>/ por /bot***/ e bot<id>:<token> por bot***. Ela é aplicada à descrição devolvida pelo Telegram, porque a mensagem do HTTPStatusError do httpx inclui a URL.
    • send_message captura qualquer exceção (por exemplo httpx.InvalidURL, que carrega a URL) e devolve só o nome do tipo.
  • app.py: filtro RedactBotToken nos handlers do root, usando o mesmo sanitize(). É defesa em profundidade para qualquer outro log que carregue a URL.

Testes

  • Os commits seguem TDD, cada test: … (red) antes do fix:.
  • Todos os testes novos usam o httpx real (Client + MockTransport) com o root em INFO e DEBUG. Cobrem:
    • o caminho feliz;
    • 400, 401, 403, 404, 429, 500 e 502 do Telegram;
    • ReadTimeout, ConnectTimeout e ConnectError;
    • uma exceção inesperada carregando a URL;
    • o /process ponta a ponta com 200 e com 500;
    • o sanitize sobre um HTTPStatusError;
    • o filtro de redação e o nível dos loggers.
  • pytest tests/unit/ --cov=data_platform: 1358 passed, cobertura acima de 82%.

Depois do deploy

  1. O usuário rotaciona o token no BotFather e cria a v2 dos secrets.
  2. Faço um único teste e confirmo com gcloud logging read que nenhuma entrada contém api.telegram.org/bot.

🤖 Generated with Claude Code

nitaibezerra and others added 4 commits November 3, 2026 10:27
…) (red)

No teste ponta a ponta de 03/11 o logger do httpx gravou "HTTP Request: POST
https://api.telegram.org/bot<TOKEN>/sendMessage" no Cloud Logging. O teste
anterior mockava httpx.post e não exercitava o logger da biblioteca. Agora:
- httpx real (Client + MockTransport) com root em INFO/DEBUG: token fora do log;
- filtro RedactBotToken nos handlers do root, redigindo bot<id>:<token>.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… filtro de redação)

O httpx loga "HTTP Request: POST <url>" em INFO e a URL da Bot API contém o token;
com o root em INFO (basicConfig do app), o token foi para o Cloud Logging no teste
ponta a ponta de 03/11 (1 entrada, revisão 00002-f9n).

- telegram.py: loggers httpx e httpcore em WARNING no import;
- app.py: RedactBotToken nos handlers do root (bot<id>:<token> → bot<redigido>),
  defesa em profundidade para qualquer outro log que carregue a URL.

O token exposto precisa ser rotacionado (BotFather) e uma versão nova adicionada
ao secret ops-alerts-telegram-bot-token.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…t) (red)

Com httpx real (MockTransport): 400/401/403/404/429/500/502, ReadTimeout,
ConnectTimeout e ConnectError sem token no log nem na descrição do resultado;
exceção inesperada não propaga com a URL; sanitize() troca /bot<...>/ por
/bot***/ (a mensagem do HTTPStatusError do httpx inclui a URL); httpx, httpcore
e urllib3 em WARNING.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…nhuma exceção vaza a URL

- telegram.sanitize(): /bot<...>/ → /bot***/ e bot<id>:<token> → bot***; aplicado
  à descrição devolvida pelo Telegram e reutilizado pelo RedactBotToken do app;
- httpx, httpcore e urllib3 em WARNING no import;
- send_message captura qualquer exceção (ex.: httpx.InvalidURL carrega a URL) e
  devolve só o nome do tipo, retentável.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@nitaibezerra
nitaibezerra merged commit d34c5d0 into main Nov 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant