Skip to content

Security: phbpx/didi

Security

SECURITY.md

Segurança / Security

Português

Como relatar uma falha

Não abra uma issue pública para uma falha de segurança. Use o relato privado do GitHub: na página do repositório, aba Security → Report a vulnerability. Descreva o problema, a versão (didi version) e como reproduzir. Você receberá uma resposta, e a correção é coordenada com você antes de qualquer divulgação.

O que o Didi faz e o que não faz

Entender o modelo ajuda a avaliar o que é uma falha:

  • Tudo é local. A base fica num diretório da sua máquina (~/.didi por padrão). O Didi não envia seus dados a nenhum serviço.
  • O que sai da máquina são só requisições de download a fontes públicas, quando você as pede: arquivos de cotações da B3 (update --download), índices e documentos da CVM (events update) e séries do Banco Central (rates update).
  • O servidor MCP (didi mcp) fala por entrada e saída padrão com o programa que o iniciou e só lê a base. As tools da carteira expõem ao assistente os registros que você lançou; --no-portfolio as esconde.
  • A API HTTP (didi serve) é somente leitura, não tem autenticação e só aceita conexões da própria máquina. --allow-remote remove essa restrição: use apenas atrás de algo que autentique, e saiba que a carteira vai junto, a menos que você passe --no-portfolio.
  • Arquivos de terceiros (ZIP e TXT da B3, PDFs da CVM, planilhas da B3) são lidos e interpretados. Um arquivo malformado que cause travamento, consumo ilimitado de memória ou escrita fora do diretório de dados é uma falha que queremos conhecer.

Versões com correção

Correções de segurança entram na versão mais recente. Não há manutenção de versões anteriores.

English

Reporting a vulnerability

Do not open a public issue for a security problem. Use GitHub's private reporting: on the repository page, Security tab → Report a vulnerability. Describe the problem, the version (didi version) and how to reproduce it. You will get an answer, and the fix is coordinated with you before any disclosure.

What Didi does and does not do

Knowing the model helps to judge what counts as a vulnerability:

  • Everything is local. The base lives in a directory on your machine (~/.didi by default). Didi does not send your data to any service.
  • What leaves the machine is only download requests to public sources, when you ask for them: B3 quote files (update --download), CVM indexes and documents (events update) and Banco Central series (rates update).
  • The MCP server (didi mcp) talks over standard input and output to the program that started it and only reads the base. The portfolio tools expose the records you entered to the assistant; --no-portfolio hides them.
  • The HTTP API (didi serve) is read-only, has no authentication and accepts connections from the local machine only. --allow-remote lifts that restriction: use it only behind something that authenticates, and know that the portfolio goes with it unless you pass --no-portfolio.
  • Third-party files (B3 ZIP and TXT files, CVM PDFs, B3 spreadsheets) are read and parsed. A malformed file that causes a hang, unbounded memory use or a write outside the data directory is a problem we want to hear about.

Supported versions

Security fixes go into the latest release. Earlier releases are not maintained.

There aren't any published security advisories