Skip to content
enrellPublic

About

Chat, voz e lives P2P entre amigos, com cara de Discord e sem servidor central

Resources

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

Nexo

image

Chat de texto, voz e lives entre amigos, com cara de Discord e sem servidor central. Tudo criptografado e seguro por padrão — veja SECURITY.md.

ci codeql

Instalar

Baixe o Nexo-Setup-<versão>.exe da última release. Ele instala com um clique (sem pedir administrador), cria atalhos e abre o app. Depois disso o Nexo abre em menos de 1 s e se atualiza sozinho.

O instalador ainda não tem a assinatura da Microsoft, então o Windows SmartScreen avisa na primeira instalação: clique em Mais informações → Executar assim mesmo. Para conferir que o arquivo é o publicado pelo pipeline: gh attestation verify Nexo-Setup-<versão>.exe -R enrell/nexo (ou compare com o SHA256SUMS.txt da release).

Como usar

  1. Escolha um nome. Sua conta é uma chave criptográfica criada no seu PC.
  2. + → Criar servidor → menu do servidor → Convidar amigos → mande o link nexo://join/... (ou o código).
  3. Quem entrar fica aguardando aprovação. Você (ou um admin) clica em Aprovar na lista de membros. Para ter certeza de que é a pessoa certa, use Verificar identidade e comparem o número de segurança.
  4. Sala de voz para conversar e Transmitir para fazer live.

Desenvolvimento

npm install
npm run dev        # Vite + Electron com hot reload
npm test           # testes unitários (~400, 2 s, sem rede nem Electron)
npm run test:cov   # idem, com cobertura e limite mínimo (o CI usa este)
npm run test:mutation  # quebra regras de segurança de propósito e confere que os testes falham
npm run test:e2e   # 21 etapas com várias instâncias reais conectadas por P2P
npm run dist       # gera release/Nexo-Setup-<versão>.exe (sem publicar)
npm run icons      # regenera build/icon.png e build/tray*.png a partir de public/logo.svg

Com just (Windows e Linux): just setup (primeira vez), just dev, just check, just dist (gera o instalador do sistema atual em release/) e just install (instala o que foi gerado). No Linux o pacote é um AppImage, instalado só para o usuário em ~/.local (just uninstall remove). Dentro do WSL, just dist-win gera o .exe sem wine (os programas do electron-builder rodam direto no Windows, via scripts/wsl-wine) e just install-win gera e instala no Windows hospedeiro; em outro Linux, dist-win usa o wine. just lista todas as receitas.

Atualização automática

O app procura atualização ao abrir e a cada 4 h, baixa só a diferença em segundo plano e avisa; Reiniciar e atualizar troca de versão em silêncio e reabre o app (ou ela é instalada ao fechar). Configurações → Sobre mostra o estado e tem Procurar atualizações. Como o instalador não é assinado pela Microsoft, a confiança vem de uma chave Ed25519 do projeto: o CI assina (versão + SHA-512 do instalador) no latest.yml e o app recusa qualquer atualização que não confira (electron/updatesig.cjs).

  • Uma vez: just update-keygen ~/nexo-update-key.pem, cadastrar a privada com gh secret set UPDATE_SIGNING_KEY < ~/nexo-update-key.pem, guardar uma cópia fora do computador (perdê-la impede atualizar quem já instalou) e colocar a pública impressa em PUBLIC_KEYS (electron/updatesig.cjs).
  • Todo release: o workflow assina sozinho (scripts/sign-update.mjs) e falha, antes de publicar, se o segredo estiver ausente ou for de outra chave.

Redutor de ruído

A supressão de ruído da voz é o DeepFilterNet3 (rede neural, MIT OR Apache-2.0) compilado do código oficial para WebAssembly e executado num AudioWorklet, dentro do computador, a 48 kHz. Tudo vai no instalador (public/denoise/, ~19 MB, com SHA256SUMS, NOTICE.md e as licenças) e o app não baixa nada de fora. Para atualizar a versão: just denoise-build (precisa de Rust com o alvo wasm32-unknown-unknown e do wasm-bindgen-cli; o script explica); depois rode os testes, que conferem os hashes e medem a supressão com o modelo real.

Testes

Camada O que cobre Onde
Unitários (Vitest) regras de moderação e convergência do log (derive), validação e assinatura dos eventos de rede (events, sanitize), cofre, identidade, backup, armazenamento e banco cifrados, convites, tema, Markdown, ErrorBoundary, guarda anti-SSRF e extração de prévias, redutor de ruído (o modelo real, no mesmo processador de áudio do app, contra ruído e fala) e o caminho do microfone tests/unit/
Mutação cada regra de segurança é quebrada de propósito, uma por vez; se nenhum teste falha, falta um teste scripts/mutation-check.mjs
Ponta a ponta (Playwright + Electron) várias instâncias reais conectadas por P2P: chat, sincronização, anexos, voz, live, moderação, persistência tests/e2e.mjs

Os unitários exigem cobertura mínima (90% das linhas, 80% dos ramos) nos módulos de regra e segurança. session.ts, audio.ts, rtc.ts e as telas ficam por conta do teste ponta a ponta. Ao achar um bug, escreva primeiro o teste que o reproduz.

Publicar uma versão

Releases saem só pelo GitHub Actions, a partir de uma tag vX.Y.Z: o pipeline confere que a tag bate com o package.json e com o CHANGELOG.md, roda os testes, gera o instalador, publica o SHA256SUMS.txt e o atestado de procedência e só então libera a release (os apps instalados se atualizam sozinhos). O passo a passo completo, com versionamento semântico e changelog, está em .claude/skills/release/SKILL.md.

Pipelines

Workflow Quando O que faz
ci push em main e PRs typecheck (app e testes), testes unitários com cobertura (Windows e Linux), build, npm audit (produção), e2e, instalador como artefato
release tag vX.Y.Z tudo do CI + publica a release com notas do CHANGELOG, SHA256SUMS e atestado
codeql push, PRs e semanal análise estática de segurança (security-extended)
Dependabot semanal atualizações de dependências npm e Actions (fixadas por hash)

O que tem

  • Interface "Constelação": grade de 3 colunas com o topo alinhado (você · servidores · busca), servidores numa barra horizontal, chat em balões e um painel contextual à direita que troca de conteúdo no lugar (agora, perfil, membros, busca, personalização). Personalizável: cores, fundo (inclusive imagem sua, guardada cifrada), opacidade dos painéis, cantos e densidade. Ícones Phosphor.
  • Chat: markdown (negrito, itálico, código, spoiler, citação), @menções com notificação, responder, editar (↑), apagar, reações, emojis, imagens e arquivos de até 25 MB (colar, arrastar ou clipe), prévia de links e YouTube, "digitando…", divisor de novas mensagens, busca no canal, mensagens pendentes quando ninguém está online.
  • Voz: escolha de microfone, saída e câmera, teste de microfone, volume de entrada e saída, detecção de voz automática ou manual, push-to-talk global (funciona dentro do jogo, aceita botões laterais do mouse), supressão de ruído por IA (DeepFilterNet, roda no seu computador), eco e ganho, anel verde em quem fala, volume individual por pessoa (0–200%), "mutar para mim", sons de entrar, sair e mutar.
  • Live: tela, janela ou câmera com áudio do PC, presets de qualidade, codec por placa de vídeo (H.264), miniatura ao passar o mouse, lista de espectadores, modo teatro (T), tela cheia (F), janela flutuante, estatísticas, retransmissão em árvore entre espectadores.
  • Moderação: aprovação de novos membros (ligada por padrão), o dono nomeia admins, admins banem (o banido é recusado por todos), gerenciam canais e renovam o convite.
  • Segurança: dados locais cifrados (AES-256-GCM, chave protegida pelo Windows), mensagens assinadas (Ed25519), handshake com channel binding contra intermediário, verificação de identidade por número de segurança, backup da conta com senha, prévias de link e conteúdo de notificação desligados por padrão. Detalhes em SECURITY.md.
  • Sistema: instalador de um clique, atualização automática, links nexo://join/... que abrem o app, bandeja (fechar mantém a voz), atalhos globais de mutar e ensurdecer, ausente automático, notificações do Windows, contador na barra de tarefas, busca global com Ctrl+K (canais, pessoas, lives e mensagens), backup e restauração da conta, exportar diagnóstico.

Como funciona sem servidor

Parte Como é feito
Encontrar os amigos Relays públicos do Nostr (via Trystero, 6 relays em paralelo) só trocam a sinalização WebRTC, criptografada com a senha do convite. Depois disso nada passa por eles.
Identidade Cada usuário tem um par de chaves Ed25519 guardado só no PC dele (cifrado). No handshake cada peer assina um desafio junto com a impressão digital do seu certificado DTLS, e a conexão é recusada se o certificado real não bater. Banidos são recusados.
Chat Log de eventos assinados (mensagem, edição, reação, cargo, ban…) que todo membro guarda (IndexedDB) e aplica com as mesmas regras, então todos chegam ao mesmo estado. Quem chega compara resumos por dia e recebe só o que falta. Ninguém consegue editar ou apagar mensagem de outro, nem se passar por admin.
Anexos Ficam no banco local de quem tem. Quem não tem pede a qualquer peer online e confere pelo hash.
Live Quem transmite manda direto para N espectadores; os outros recebem de espectadores que retransmitem. Se um retransmissor cai, quem dependia dele reconecta sozinho.
Voz Malha completa: cada um manda o microfone (já processado) para os outros da sala.

Limitações conhecidas

  • NAT restritivo (alguns 4G/CGNAT): se dois amigos nessa situação não conectarem, configure um TURN em Configurações → Rede (coloque também as URLs ?transport=tcp e turns: na porta 443, que passam quando a operadora bloqueia UDP) e use Testar TURN para conferir.
  • Convite renovado: quem estava offline na hora precisa do convite novo.
  • Histórico: só existe nos PCs dos membros. Se ninguém que tem uma mensagem estiver online, quem entrar não a recebe até alguém aparecer.
  • Áudio do PC na live (Windows): captura tudo o que toca. O Nexo pede ao Chromium para excluir o próprio áudio (voz dos amigos), mas, se ela aparecer, transmita uma janela em vez da tela inteira ou use fone.
  • Versões anteriores à 0.3 não conversam com a 0.3 (protocolo novo, com channel binding). Atualize e crie um servidor novo.
  • A qualidade da live começa mais baixa e sobe em uns 20–30 s, enquanto o WebRTC mede a banda.

Estrutura

  • electron/main.cjs: janela, bandeja, protocolo nexo://, atalhos globais, push-to-talk (uiohook), auto-update, prévia de links, captura de tela
  • src/lib/session.ts: uma sala P2P (handshake, log de eventos, sync, anexos, live em árvore, voz)
  • src/lib/derive.ts: regras que transformam o log de eventos no estado do servidor
  • src/lib/vault.ts, storage.ts, db.ts: cofre (AES-256-GCM), armazenamento local e banco cifrados
  • src/lib/identity.ts, rtc.ts, audio.ts: chaves e backup, certificado DTLS/codecs, motor de voz
  • src/lib/app.ts: estado global (servidores, perfil, configurações, notificações)
  • src/components/: interface
  • src/lib/events.ts, src/lib/sanitize.ts: tudo que chega da rede (eventos, presença, perfil) é validado aqui antes de ser guardado ou desenhado
  • tests/unit/: testes unitários; tests/e2e.mjs: teste ponta a ponta

About

Chat, voz e lives P2P entre amigos, com cara de Discord e sem servidor central

Resources

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages