michal-pielka/punchlineMensageiro criptografado peer-to-peer em Rust com Noise IK e UDP NAT hole punching
Chat ponto a ponto criptografado de ponta a ponta via UDP. Sem contas, sem servidor central retransmitindo/armazenando mensagens, sem intermediário. Apenas dois pares, uma conexão direta e criptografia pelo protocolo Noise.
https://github.com/user-attachments/assets/939e96d3-45e3-4484-9a27-28c3a0457b05
Duas pessoas executam punchline connect <peer> em suas máquinas. O Punchline atravessa seus NATs, realiza um handshake criptografado e os coloca em um chat privado – tudo em alguns milissegundos. Os servidores STUN e de sinalização incluídos cuidam da descoberta e depois saem do caminho.
cargo build --release
Inicie os servidores (em uma máquina que ambos os pares possam acessar) ou use os meus públicos hospedados em 64.225.107.28 (STUN: porta 3478, sinalização: porta 8743):
punchline-stund # Servidor STUN - informa aos pares seu IP público
punchline-signald # Servidor de sinalização - combina pares que querem conversar
Em cada máquina dos pares:
# Gere sua identidade (par de chaves X25519)
punchline keygen
# Compartilhe sua chave pública com seu par
punchline pubkey
# Salve a chave dele
punchline peers add alice a1b2c3d4...64_hex_chars
# Conecte-se (ambos os pares executam isso, direcionando um ao outro)
punchline connect alice --stun <servidor>:3478 --signal <servidor>:8743
A TUI é iniciada com uma visualização do progresso da conexão ao vivo:
Descoberta STUN - resolvendo seu endereço externo via punchline-stund
Servidor de sinalização - conectando ao punchline-signald
Aguardando o par - o servidor de sinalização combina ambos os pares
Furação de NAT - estabelecendo o caminho UDP direto
Handshake Noise - troca de chaves criptografada
Quando concluído, você está no chat. Digite e pressione Enter. Pressione Esc para sair.
Todo o sistema consiste em três binários, todos incluídos neste repositório:
| Binário | Função | Quando usado |
|---|---|---|
punchline-stund | Servidor STUN (UDP) - responde com o IP:porta externo do cliente | Apenas durante a configuração |
punchline-signald | Servidor de sinalização (WebSocket) - combina pares e troca endereços | Apenas durante a configuração |
punchline | O próprio mensageiro - CLI, TUI, criptografia, furação de NAT | Sempre |
Após a configuração inicial, os servidores STUN e de sinalização não são mais contatados. Tudo flui diretamente entre pares.
punchline| Comando | Descrição |
|---|---|
keygen [--force] [-i caminho] | Gera um novo par de chaves de identidade X25519. Use --force para sobrescrever sem confirmação. Use -i para especificar o caminho de saída. |
pubkey [-i caminho] | Imprime sua chave pública (64 caracteres hexadecimais). Use -i para derivar de um arquivo de chave específico. |
connect <par> [-i caminho] [--stun endereço] [--signal endereço] | Conecta-se a um par por apelido ou chave hex bruta. Use -i para especificar a chave de identidade. Inicia a TUI. |
peers | Lista todos os pares conhecidos. |
peers add <nome> <chave> | Salva a chave pública de um par sob um apelido. |
peers remove <nome> | Remove um par pelo apelido. |
config path | Exibe o caminho do arquivo de configuração. |
config show | Mostra os valores atuais da configuração. |
status | Mostra identidade, configuração, alcançabilidade do servidor e número de pares. |
completions <shell> | Gera completudes para o shell (bash, zsh ou fish). |
Bandeiras globais:
| Bandeira | Descrição |
|---|---|
-v | Aumenta a verbosidade do log (-v = debug, -vv = trace). |
-q, --quiet | Suprime toda a saída de log. |
punchline-stund| Bandeira | Descrição |
|---|---|
--address <endereço> | Endereço de escuta (padrão: 0.0.0.0). |
--port <porta> | Porta de escuta (padrão: 3478). |
-v / -vv | Log debug / trace. |
-q | Modo silencioso. |
punchline-signald| Bandeira | Descrição |
|---|---|
--address <endereço> | Endereço de escuta (padrão: 0.0.0.0). |
--port <porta> | Porta de escuta (padrão: 8743). |
-v / -vv | Log debug / trace. |
-q | Modo silencioso. |
Em vez de passar --stun e --signal toda vez, crie ~/.config/punchline/config.toml:
stun_server = "203.0.113.10:3478"
signal_server = "203.0.113.10:8743"
punchline peers # listar todos
punchline peers add alice a1b2c3d4... # adicionar
punchline peers remove alice # remover
Os apelidos são armazenados em ~/.punchline/known_peers.toml. Você também pode conectar diretamente com uma chave hex bruta de 64 caracteres.
punchline status
Mostra sua identidade, configuração, alcançabilidade do servidor (envia uma sonda STUN real e conexão TCP) e número de pares.
Ambos os servidores suportam -v (debug), -vv (trace), -q (silencioso), --address e --port:
punchline-stund -v --port 3478
punchline-signald -v --port 8743
Personalize a TUI via ~/.config/punchline/style.toml
Estilos usados no vídeo:
[colors]
my_text = "#ebdbb2"
peer_text = "#bdae93"
input_text = "#ebdbb2"
border = "#ebdbb2"
sidebar_key = "#ebdbb2"
sidebar_value = "#bdae93"
[padding]
chat_horizontal = 2
chat_vertical = 1
Todas as cores são RGB hex. Se o arquivo estiver ausente, as cores padrão do terminal são usadas.
punchline completions bash > ~/.local/share/bash-completion/completions/punchline
punchline completions zsh > ~/.zfunc/_punchline
punchline completions fish > ~/.config/fish/completions/punchline.fish
Nome completo do protocolo: Noise_IK_25519_ChaChaPoly_SHA256